API Endpoint and Authentication
Your API endpoint varies based on where your Webex Connect account is hosted. Visit Know Your API Endpoint section to know more.
You can use either Service Key or JSON Web Tokens (JWT) for authentication. If you use both JWT authentication and Service Key in an API request, JWT authentication takes priority, and the Service Key is ignored.
The messaging API supports batching. You can send personalized messages to a maximum of 1000 destinations at once (subject to your TPS limits). E.g., if your messaging API TPS configuration is 10 you can send messages to up to 10 destinations at once.
Prerequisites
Channel | Prerequisite |
---|---|
SMS | Sender ID - A Sender ID is a name or number that an SMS appears to come from (‘from address’) when you receive a message on your phone. A sender ID can be alpha-numeric or a short-code or a long-code depending on demographical restrictions |
You will need to set up an Email app within Webex Connectand verify your domain before you are able to send emails. Please contact the Support team for any assistance in setting up Email app | |
RCS | RCS chatbot needs to be created on all operators in geography before RCS messages can be sent. This setup takes at least 7 days after submission on the UI under the apps section of Webex Connect |
MMS |
Messaging API v2 - Samples
{
"appid": "<channel asset specific App ID available in Assets page>", //This is required only for Push, In-App, Messenger, WhatsApp, and Apple Messages for Business
"channel": "<channel name - v2 API currently supports sms, email and rcs",
"from": "<from address for the message, for SMS this will be a senderID, for email the sender address and for all OTT channels it will be appId available on the UI>",
"to": [
{
"msisdn/email": [
"single/multiple destination objects of the same type" //MSISDN i.e., phone numbers in E.164 format
],
"correlationId": "<correlationId for this array of destination objects>",
"substitutions": {
"parameter1": "<substitutions for this array of destination objects> ",
"parametern": "<substitutions for this array of destination objects> "
}
},
// Pass multiple objects in a single destination array for bulk messaging
// Pass one object in each destination array for personalized messaging
{
"msisdn/email": [
"single/multiple destination objects of the same type"
],
"correlationId": "<correlationId for this array of destination objects>",
"substitutions": {
"parameter1": "<substitutions for this array of destination objects> ",
"parametern": "<substitutions for this array of destination objects> "
}
}
],
// Global substitutions
"substitutions": {
"parameterx": "<global replaceable parameters, destination level parameters take precendence",
},
// Message scheduling
"sendAt": "{{TimeinUTC}}",
//max 7 days from current time
"expireAt": "{{TimeinUTC}}", //Either(expireAt/validity)one can be passed.If both are provided then you will receive a 400 Bad request.
"validity": "time period in seconds", //For e.g., 60 for 60 seconds
// Channel specific message options
"options": {
object(smsOptions)||object(emailOptions)||Object(rcsOptions)
},
// Call-backs
"callbackData": "<notify data>",
"notifyUrl": "https://notify.example.com",
"requestedReceipts": [
"DELIVERED",
"READ"
],
// Union field message can be only one of content or template
"content": {
object(smsMessage)||object(emailMessage)||object(rcsMessage)
},
"template": {
"id": "<unique template ID fom the UI"
}
//Optional object if you want to use Contact Policy
"contactPolicy": {
“contactPolicyGroup” : "xKa4xfM3S_a9bP98ryCw8w", //the GroupID to be applied. Required if any of the following options are included and set to true
“channelCheckConsent” : true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
“channelApplyFrequencyCap” : true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
}
}
{
"channel": "rcs",
"from": "{{rcsAppId}}",
"to": [
{
"msisdn": [
"{{msisdn}}" //E.164 format required/recommended.
],
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
}
}
],
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
},
"options": {
"smsFallback": true,
"smsSenderId": "{{senderid}}",
"text": "fallback text"
},
"requestedReceipts": [
"DELIVERED"
],
"content": {
"type": "text",
"text": "This is the message. Reply Yes or No.",
"suggestions": [
{
"type": "reply",
"displayText": "Yes",
"postbackData": "usr_msg_yes"
},
{
"type": "viewLocation",
"address": "",
"displayText": "",
"latitude": 0,
"longitude": 0,
"postbackData": ""
},
{
"type": "shareLocation",
"displayText": "",
"postbackData": ""
},
{
"type": "openUrl",
"displayText": "",
"url": "",
"postbackData": ""
},
{
"type": "calendarEvent",
"displayText": "",
"startTime": "{{TimeinUTC}}",
"endTime": "{{TimeinUTC}}",
"meetingTitle": "",
"meetingDescription": "",
"postbackData": ""
},
{
"type": "dialPhone",
"displayText": "",
"phone": "",
"postbackData": ""
}
]
},
"callbackData": "", //Data that you have configured to receive on the notify Url. This is configured as a part of the request.
"correlationId": "", //The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
"notifyUrl": "",
"contactPolicy": {
"contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
"channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
"channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
}
}
Postman Collection
Here is a Postman collection to test our APIs. Make sure you change the key in the header to your service key.
Archived Collection:Refer Postman Collection
Generating the JWT Token
Connect uses a subset of the JWT fields, described here:
alg
A string used in the header, identifying the algorithm used to encode the payload. The alg value is always HS256 when exchanging messages with Business Chat.iss
A claim that is a string identifying the principal that issued the JWT. The value is always the Service ID when exchanging messages with API V2.iat
A claim that is a numeric date—that is, an integer—identifying the time at which the JWT was issued. The value is the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date and time, ignoring leap seconds. For more information, see the Terminology section in RFC 7519.A Service Secret that is a Base64-encoded string. Decode the string before using the key to sign the JWT
A decoded JWT token should contain the following -
header
{
"alg": HS256,
}
claims
{
"iss": <Service ID>,
"iat": <issued at unix-timestamp (in seconds)>
}
Body Parameters
Parameter | Type | Mandatory | Description |
---|---|---|---|
channel | enum | yes | email * rcs |
from | string | yes | _ email - [email protected] (domain needs to be registered in apps) * rcs - app ID generated on the UI |
to | JSONArray | yes | array of destination JSON objects that contain the channel specific destination and personalized substitutions for each destination object. MSISDN i.e., phone numbers should be in E.164 format. Channel wise destinations - _ email - email * rcs - msisdn |
substitutions | JSONObject | no | a JSON object with global substitutions. If a variable exists both in personalized substitutions and global substitutions, the personalized substitution takes preference |
sendAt | date/time | yes | The timestamp of the message to be delivered (maximum 7 days) For example, _ 2021-06-26T13:47:18.000Z - UTC |
expireAt | date/time | yes | The time format for when the message has to be expired and failed if not delivered For example, _ 2021-06-26T13:47:18.000Z - UTC |
validity | string | yes | Time period in seconds. E.g., 60 for sixty seconds. Only one of expireAt or validity should be sent in the request. The request will not be accepted if both values are present in the payload. If both sendAt and validity parameters are present in the same request, the validity time period will be added to the sendAt time to decide the expiry time. |
options | JSONObject | no | a JSON object that contains additional channel specific options in API. More information under each channel below |
callbackData | string | no | A string that is returned with each outbound web-hook for the message (delivery, failed etc). Maximum number of characters allowed in callbackData including any spaces is 2000. |
notifyUrl | string | no | a HTTPS endpoint for message delivery web-hooks |
requestedReceipts | JSONArray | no | a JSON array that can filter message delivery web-hooks to the notifyURL. Can contain one or more of the following for each channel _ email - "Parameter", "h-1": "Type", "h-2": "Mandatory", "h-3": "Descriptio * rcs - ": "Type", "h-2": "Mandatory", Check Outbound Webhooks for more information on receipts |
content | JSONObject | yes, if template is not provided | contains the content of the message for each channel. see below for more examples |
template | JSONObject | yes, if content is not provided | contains the template id for each channel that's configured on the UI |
RCS Channel
Best Practices
- Send one of textMessage, fileMessage, audioMessage, richcardMessage, or richCardCarousel to a subscriber at a time, allowing for necessary delivery and response time between messages.
- One and only one suggestedChipList can be used together with one and only one of textMessage, fileMessage, audioMessage, geolocationPushMessage, or richcardMessage. Note that suggestion actions available today are reply, calendar, map location, open URL, and dial. Different suggestion action types can be combined in a single suggestedChipList.
- A suggestedChipList shall not be sent without an accompanying message.
- Single rich card messages can be configured as short, medium, or tall with a suggestion. Rich card carousels are limited to short or medium rich cards with a suggestion.
- Some mobile network RCS service providers wait for a delivery receipt for a text message prior to sending any related suggestion. Ensure your test plans include each carrier your program will terminate to.
- The fileMessage and richCardMessage parameter fileSize requested is related to image and videos contained in URLs. The measurement shall be in bytes and while not all MaaPs require an accurate fileSize, the size shall not be 0.
- Please note that the substitutions apply only to text field.
rcsOptions
parameter | type | description |
---|---|---|
smsFallback | boolean | when true, auto SMS fallback will be tried for RCS failures. If this parameter is not passed, SMS fallback will be disabled by default. Refer to the note below for details on how it works. |
smsSenderId | string | Sender ID that is already configured on your account |
text | string | text message up-to 1024 chars |
carrierId | string | if you already know the carrier of the end customer, you can pass this as an optional parameter. increases the throughput of RCS outbound messagesfor list of carrierIds, check here |
Limitation
The routing of SMS messages will be handled by the standard routing rules configured for your tenant. Please reach out to your account manager for more information
smsFallback Parameter
If the smsFallback parameter is set to 'true' in the Webex Connect messaging API to enable SMS fallback for RCS messages, then the smsSenderId and text fields become mandatory, to ensure that the fallback message is sent successfully.
For more information on how the feature works, refer to the FAQs chapter.
{
"smsFallback":true, //to enable sms fallback if user is not RCS enabled
"smsSenderId":"senderaddress",
"text":"fallback text",
"carrierId":"12"
}
rcsMessage
parameter | type | mandatory | description |
---|---|---|---|
type | string | yes | text, media, standalone, carousel, agentEvent |
text | string | yes, if type = text | up to 3072 chars |
mediaContentUrl | string | yes, if type = media | a publicly accessible direct media Url ending in the attachment mimeType |
richCard | JSONObject | yes, if type = standalone | a JSON object containing rich card data and suggestions |
width | string | yes, if type = carousel | a parameter that indicates the width of carousel cards |
cards | JSONArray | yes, if type = carousel | a JSON array containing carousel card objects and their suggestions |
event | string | yes, if type = agentEvent | a typing or a read event to be sent to the customer |
suggestions | JSONArray | no | a JSON array that can contain upto 10 suggestions with a message, 2 when within a carousel and 4 when within a richcard reply viewLocation shareLocation openUrl calendarEvent dialPhone |
{
"channel": "rcs",
"from": "{{rcsAppId}}",
"to": [
{
"msisdn": [
"{{msisdn}}" //E.164 format required/recommended.
],
"correlationId": "", //The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
}
}
],
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
},
"options": {
"smsFallback": true,
"smsSenderId": "{{senderid}}",
"text": "fallback text"
},
"requestedReceipts": [
"DELIVERED"
],
"content": {
"type": "text",
"text": "This is the message. Reply Yes or No.",
"suggestions": [
{
"type": "reply",
"displayText": "Yes",
"postbackData": "usr_msg_yes"
},
{
"type": "viewLocation",
"address": "",
"displayText": "",
"latitude": 0,
"longitude": 0,
"postbackData": ""
},
{
"type": "shareLocation",
"displayText": "",
"postbackData": ""
},
{
"type": "openUrl",
"displayText": "",
"url": "",
"postbackData": ""
},
{
"type": "calendarEvent",
"displayText": "",
"startTime": "{{TimeinUTC}}",
"endTime": "{{TimeinUTC}}",
"meetingTitle": "",
"meetingDescription": "",
"postbackData": ""
},
{
"type": "dialPhone",
"displayText": "",
"phone": "",
"postbackData": ""
}
]
},
"callbackData": "", //Data that you have configured to receive on the notify Url. This is configured as a part of the request.
"notifyUrl": "",
"contactPolicy": {
"contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
"channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
"channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
}
}
{
"channel": "rcs",
"from": "{{rcsAppId}}",
"to": [
{
"msisdn": [
"{{msisdn}}" //E.164 format required/recommended.
],
"correlationId": "", //The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
}
}
],
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
},
"options": {
"smsFallback": true,
"smsSenderId": "{{senderid}}",
"text": "fallback text"
},
"requestedReceipts": [
"DELIVERED"
],
"content": {
"type": "media",
"mediaContentUrl": "https://asset.com/asset.jpg",
"suggestions": [
{
"type": "reply",
"displayText": "",
"postbackData": ""
},
{
"type": "viewLocation",
"address": "",
"displayText": "",
"latitude": 0,
"longitude": 0,
"postbackData": ""
},
{
"type": "shareLocation",
"displayText": "",
"postbackData": ""
},
{
"type": "openUrl",
"displayText": "",
"url": "",
"postbackData": ""
},
{
"type": "calendarEvent",
"displayText": "",
"startTime": "{{TimeinUTC}}",
"endTime": "{{TimeinUTC}}",
"meetingTitle": "",
"meetingDescription": "",
"postbackData": ""
},
{
"type": "dialPhone",
"displayText": "",
"phone": "",
"postbackData": ""
}
]
},
"callbackData": "", //Data that you have configured to receive on the notify Url. This is configured as a part of the request.
"notifyUrl": "",
"contactPolicy": {
"contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
"channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
"channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
}
}
{
"channel": "rcs",
"from": "{{rcsAppId}}",
"to": [
{
"msisdn": [
"{{msisdn}}" //E.164 format required/recommended.
],
"correlationId": "", //The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
}
}
],
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
},
"options": {
"smsFallback": true,
"smsSenderId": "{{senderid}}",
"text": "fallback text"
},
"requestedReceipts": [
"DELIVERED"
],
"content": {
"type": "standalone",
"richCard": {
"title": "",
"description": "",
"orientation": "",
"thumbnailAlignment": "LEFT",
"media": {
"height": "SHORT/MEDIUM/TALL",
"url": "https://bit.ly/2J5i2x0"
},
"suggestions": [
{
"type": "reply",
"displayText": "",
"postbackData": ""
},
{
"type": "viewLocation",
"address": "",
"displayText": "",
"latitude": 0,
"longitude": 0,
"postbackData": ""
}
]
},
"suggestions": [
{
"type": "reply",
"displayText": "",
"postbackData": ""
},
{
"type": "viewLocation",
"address": "",
"displayText": "",
"latitude": 0,
"longitude": 0,
"postbackData": ""
}
]
},
"callbackData": "", //Data that you have configured to receive on the notify Url. This is configured as a part of the request.
"notifyUrl": "",
"contactPolicy": {
"contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
"channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
"channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
}
}
{
"channel": "rcs",
"from": "{{rcsAppId}}",
"to": [
{
"msisdn": [
"{{msisdn}}" //E.164 format required/recommended.
],
"correlationId": "", //The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
}
}
],
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
},
"options": {
"smsFallback": true,
"smsSenderId": "{{senderid}}",
"text": "fallback text"
},
"requestedReceipts": [
"DELIVERED"
],
"content": {
"type": "carousel",
"suggestions": [
{
"type": "reply",
"displayText": "",
"postbackData": ""
},
{
"type": "viewLocation",
"address": "",
"displayText": "",
"latitude": 0,
"longitude": 0,
"postbackData": ""
},
{
"type": "shareLocation",
"displayText": "",
"postbackData": ""
},
{
"type": "openUrl",
"displayText": "",
"url": "",
"postbackData": ""
},
{
"type": "calendarEvent",
"displayText": "",
"startTime": "{{TimeinUTC}}",
"endTime": "{{TimeinUTC}}",
"meetingTitle": "",
"meetingDescription": "",
"postbackData": ""
},
{
"type": "dialPhone",
"displayText": "",
"phone": "",
"postbackData": ""
}
],
"width": "SMALL/MEDIUM",
"cards": [
{
"title": "",
"description": "",
"media": {
"height": "SHORT/MEDIUM/TALL",
"url": "https://bit.ly/2J5i2x0"
},
"suggestions": [
{
"type": "reply",
"displayText": "",
"postbackData": ""
},
{
"type": "viewLocation",
"address": "",
"displayText": "",
"latitude": 0,
"longitude": 0,
"postbackData": ""
}
]
},
{
"title": "",
"description": "",
"media": {
"height": "SHORT/MEDIUM/TALL",
"url": "https://bit.ly/2P5Q9dK"
},
"suggestions": [
{
"type": "reply",
"displayText": "",
"postbackData": ""
},
{
"type": "viewLocation",
"address": "",
"displayText": "",
"latitude": 0,
"longitude": 0,
"postbackData": ""
}
]
}
]
},
"callbackData": "", //Data that you have configured to receive on the notify Url. This is configured as a part of the request.
"notifyUrl": "",
"contactPolicy": {
"contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
"channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
"channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
}
}
{
"channel": "rcs",
"from": "{{rcsAppId}}",
"to": [
{
"msisdn": [
"{{msisdn}}" //E.164 format required/recommended.
],
"correlationId": "", //The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
}
}
],
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
},
"options": {
"smsFallback": true,
"smsSenderId": "{{senderid}}",
"text": "fallback text"
},
"requestedReceipts": [
"DELIVERED"
],
"content": {
"type": "agentEvent",
"event": "IS_TYPING"
},
"callbackData": "", //Data that you have configured to receive on the notify Url. This is configured as a part of the request.
"notifyUrl": "",
"contactPolicy": {
"contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
"channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
"channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
}
} "latitude": 0,
"longitude": 0,
"postbackData": ""
},
{
"type": "shareLocation",
"displayText": "",
"postbackData": ""
},
{
"type": "openUrl",
"displayText": "",
"url": "",
"postbackData": ""
},
{
"type": "calendarEvent",
"displayText": "",
"startTime": "{{TimeinUTC}}",
"endTime": "{{TimeinUTC}}",
"meetingTitle": "",
"meetingDescription": "",
"postbackData": ""
},
{
"type": "dialPhone",
"displayText": "",
"phone": "",
"postbackData": ""
}
],
"width": "SMALL/MEDIUM",
"cards": [
{
"title": "",
"description": "",
"media": {
"height": "SHORT/MEDIUM/TALL",
"url": "https://bit.ly/2J5i2x0"
},
"suggestions": [
{
"type": "reply",
"displayText": "",
"postbackData": ""
},
{
"type": "viewLocation",
"address": "",
"displayText": "",
"latitude": 0,
"longitude": 0,
"postbackData": ""
}
]
},
{
"title": "",
"description": "",
"media": {
"height": "SHORT/MEDIUM/TALL",
"url": "https://bit.ly/2P5Q9dK"
},
"suggestions": [
{
"type": "reply",
"displayText": "",
"postbackData": ""
},
{
"type": "viewLocation",
"address": "",
"displayText": "",
"latitude": 0,
"longitude": 0,
"postbackData": ""
}
]
}
]
},
"callbackData": "", //Data that you have configured to receive on the notify Url. This is configured as a part of the request.
"notifyUrl": "",
"contactPolicy": {
"contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
"channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
"channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
}
}
{
"channel": "rcs",
"from": "{{rcsAppId}}",
"to": [
{
"msisdn": [
"{{msisdn}}" //E.164 format required/recommended.
],
"correlationId": "", //The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
}
}
],
"substitutions": {
"{{rcs_parameter1}}": "{{rcs_value1}}"
},
"options": {
"smsFallback": true,
"smsSenderId": "{{senderid}}",
"text": "fallback text"
},
"requestedReceipts": [
"DELIVERED"
],
"content": {
"type": "agentEvent",
"event": "READ",
"messageId": ""
},
"callbackData": "", //Data that you have configured to receive on the notify Url. This is configured as a part of the request.
"notifyUrl": "",
"contactPolicy": {
"contactPolicyGroup": "", //the GroupID to be applied. Required if any of the following options are included and set to true
"channelCheckConsent": true, //optional, assumed false, set to true to require opt-in before sending the message,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
"channelApplyFrequencyCap": true //optional, assumed false, set to true to enforce group frequency cap for that channel,“channelCheckConsent” or “channelApplyFrequencyCap” either of the parameter should be “true”
}
}
Suggestions
reply
Suggested replies help your chatbot guide users through conversations by providing responses that the chatbot knows how to react to. Your agent sends replies in suggestion chip lists or rich cards.viewLocation
The View location action displays a location in the user's default map app. You can specify the location either by latitude and longitude or with a query based on the user's current location. You can also set a custom label for the pin that displays in the map app.shareLocation
The Share location action lets the user send a location to your chatbot.openUrl
The Open URL action opens the user's web browser to the specified URL. If an app is registered as a default handler for the URL, the app opens instead, and the icon for the action is the app's icon.calendarEvent
The Create calendar event action opens the user's calendar app and begins to create a new event with the specified information.dialPhone
The Dial action guides the user to dial a phone number that your chatbot specifies.