get https://examplebaseURL.com/v1/api/apps//data/sms-detail
Response Format
Parameter | Type | Description |
---|---|---|
id | String | The unique id generated by CX. |
fromEID | String | The staff ID of the sender. |
date | String | The date on which the SMS was sent. |
cid | String | (Internal use) |
text | String | The content of the SMS message. |
sender | Number | The SMS sender ID. |
recipient | String | The number to which the SMS was sent. |
recipientCountryCode | String | The country or region to which the SMS was sent. |
status | String | The status of the SMS message. It should be one of the following: - Submitted (The SMS message has been submitted to the carrier); - Rejected (The SMS message has been rejected by the carrier) |
carrierStatus | String | The delivery status of the submitted SMS message in the carrier network. It should be one of the following: - Queued (The carrier network accepted the SMS message); - Delivered (The carrier network delivered the SMS message); - Undelivered (The carrier network did not deliver the SMS message). |
usage | String | The SMS message source. It should be one of the following: - direct (The direct engagement to customers via SMS); - verification (The SMS message for verification); - openAPI-sms (The SMS message sent using OpenAPI); - openAPI-otp (The one-time password sent via SMS using OpenAPI) |
createdAt | String | The date and time on which the SMS was sent. |
updatedAt | String | The date and time on which the SMS record was updated. |