patch https://examplebaseURL.com/v1/api/apps//inbound-sms-event-sub
Response Format
| Parameter | Type | Description |
|---|---|---|
| enabled | boolean | It must be true or false. True indicates the subscription is successful, while false indicates it is unsuccessful. |
| url | String | The webhook URL. In access to this URL, you can receive the notification of the inbound SMS message when sent to Cinnox. For details, please refer to the Notification of the New Inbound SMS Message. |
| updatedAt | String | The updated date and time of this subscription. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
Notification of the New Inbound SMS Message
You can receive the notification of the new inbound SMS message by accessing the webhook URL after subscribing to the event of the Inbound SMS message.
| Notification Details | Type | Description |
|---|---|---|
| id | Strings | The record ID of the SMS message. |
| eventDescription | Strings | The type of event you subscribed to. It must be the Inbound SMS. |
| senderNumber | Number | The sender number of the SMS message. |
| recipientNumber | Number | The recipient's SMS number. The format is "Country code + phone number". Example: 85298765432. |
| receiveTime | Strings | The date and time of receiving the SMS message. The value must be in RFC3339 format, e.g. 2022-11-07T00:00:00.000Z. |
| contentType | Strings | The content type of the SMS message. It must be "Text". |
| content | Strings | The content of the SMS message. |
Webhook URL Requirement:
The webhook URL needs to be verified. After that, you will get a POST request with an Action and are required to set the response in JSON Response format as shown below:
Note that the JsonResponse result is JSON encoding of the Action Endpoint Response.
Action Endpoint Request {
+ Challenge string json:"challenge"
+ }Action Endpoint Response {
+ Challenge string json:"challenge"
+ }Json Response {
+ Code int json:"code"
+ Result json.RawMessage json:"result"
+ }