Communications API (4.0.0)

Download OpenAPI specification:Download

E-mail: support@venturedsolutions.com License: Apache 2.0

Delivery APIs

Send

This action supports delivery of message content based on customer configured routing rules on a per contact basis.

In your request, you can include content for:

SMS
Email
Push Notification
Eduspot Timeline

This API method will examine the customer/recipient routing configuration and determine which content to deliver to each defined recipient, based on the customer's configuration in the Groupcall or Teachers2Parents platform.

When working with schools, it is recommended to include content for all routes to ensure greatest flexibility based on the customer's configuration and local data.

When identifying your recipient, prefer to use the IdaasId property. It is the unique person identifier in scope of the school obtained from Xporter Data. It can also be constructed with aconsistent prefix per person type and MISID.

PersonType	Prefix
Student	PL-
Student Contact	PC-
Staff	PWT-

When working with other organisations or anonymous recipients, provide content for the message type you intend to send eg SMS only.

header Parameters

Authorization

string

Idaas {STS_TOKEN}

Request Body schema: application/json

Send Message

Array of objects

Array

callbackUrl	string Provide URL endpoint to receive status updates and responses
clientRef	string
emailBody	string Email body content
emailReplyToAddress	string Email reply to address
emailSentFromAddress	string Email sent from address
emailSentFromName	string Email sent from name
emailSubject	string Email subject
required	Array of objects (recipient) List of recipients
	Array of objects Optional list of attachments, only valid
sendDateTime	string
smsMessage	string
	object Optional list of dynamic tokens that can be referenced in the message body
NotificationMessage	string Content for Push Notification
XpressionsBody	string Eduspot body for sending specific content to Eduspot, not default SMS/Email

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"messageData": [{"ClientRef": "5E4F539B-E2D1-4178-B31F-244E8E403A9F",
"EmailSentFromName": "Primary Test Demo",
"EmailSentFromAddress": "noreply@datatool.groupcall.com",
"EmailReplyToAddress": "partner@datatool.groupcall.com",
"EmailSubject": "*Email* & SMS - Basic",
"EmailBody": "*Email* & SMS - Dear $Name$, you have been tested $Date$",
"XpressionsBody": "Rich content message to appear in the app timeline feed",
"NotificationMessage": "Simple content for push notification",
"SMSMessage": "$Firstname$ has not registered for school this morning, please provide a reason",
"CallbackUrl": "https://apitesting.xporter.one/TryIt/Callback",
"Recipients": [{"ClientId": "C613474F-F849-4CBF-9C4D-440C59ECA61E",
"SendTo": "1,",
"IdaasId": "PL-4158",
"DynamicTokens": [{"$Firstname$": "James"
}
]
}
]
}
],
"styleClass": "TestPartner"
}

Response samples

200

Content type

application/json

{"MessageSentId": 0,
"MessageId": "1261.20221107.02517344439098830760-9616fca7b64f405fa9116059403a868f",
"statusMsg": "In Queue",
"transmitDateTime": "2022-11-07T21:34:51.3826134Z",
"ClientRef": "5E4F539B-E2D1-4178-B31F-244E8E403A9F",
"WarningMessages": [null
]
}