SMS Verify API - Which method should I use to get delivery status?

This page gives you an overview of the two methods available for obtaining final delivery status, explains the relative advantages of each one, and gives you recommendations on which one to choose.

Although the status.code property in the response tells you the delivery status of the generated SMS with respect to the destination carrier, it does not indicate the delivery status all the way to the end-user.

Options:

  • GET /v1/verify/{reference_id} - Get the status of an individual transaction by querying a REST API, for up to 12 hours after sending your message.
    • Advantage: If Telesign generated your code, you are already making this request to complete verification. So you can get delivery status from its response without needing to do any additional integration work.
  • Transaction Callback Service - Receive status updates pushed from Telesign, at a URL that you provide.
    • Advantage: When you are generating your own codes and you have a high volume of transactions, using this method avoids having to make an additional REST API call.
    • Disadvantage: You need to do some additional integration work to create this endpoint and process our pushes.

So in summary, if you are generating your own verification code and expect a high-volume of transactions, use the Transaction Callback Service to get delivery status.

Otherwise, use GET /v1/verify/{reference_id}.