Response Format

ParameterTypeDescription
idStringThe unique id generated by CX.
fromEIDStringThe staff ID of the sender.
dateStringThe date on which the SMS was sent.
cidString(Internal use)
textStringThe content of the SMS message.
senderNumberThe SMS sender ID.
recipientStringThe number to which the SMS was sent.
recipientCountryCodeStringThe country or region to which the SMS was sent.
statusStringThe 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)
carrierStatusStringThe 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).
usageStringThe 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)
createdAtStringThe date and time on which the SMS was sent.
updatedAtStringThe date and time on which the SMS record was updated.
Language