Skip to content

Latest commit

 

History

History
130 lines (130 loc) · 3.45 KB

Get SMS message state.md

File metadata and controls

130 lines (130 loc) · 3.45 KB

Get SMS message state

Get informations on the SMS delivery status of the given order_id.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user token sections.
All the query string parameters in URL must be UTF-8 URL Encoded.

HTTP Headers

user_key / Session_key

HTTP Method

GET

HTTP Request

https://app.gateway.smsend.it/API/v1.0/REST/sms/{order_id}

Parameters

Parameter Type Description Required Default
order_id String The order ID Yes -

Returns

Code Description
200 A Json object representing the status of the given SMS order.
400 Other errors, details are in the body
401 [Unauthorized] User_key, Token or Session_key are invalid or not provided
404 [Not found] The order_id was not found

Possible returned statuses are:

Status Value
WAITING “WAITING”
SENT_TO_SMSC “SENT”
WAITING_DELIVERY “WAIT4DLVR”
SENT “SENT”
DELIVERY_RECEIVED “DLVRD”
TOO_MANY_SMS_FROM_USER “TOOM4USER”
TOO_MANY_SMS_FOR_NUMBER “TOOM4NUM”
ERROR “ERROR”
TIMEOUT “TIMEOUT”
UNPARSABLE_RCPT “UNKNRCPT”
UNKNOWN_PREFIX “UNKNPFX”
SENT_IN_DEMO_MODE “DEMO”
WAITING_DELAYED “SCHEDULED”
INVALID_DESTINATION “INVALIDDST”
NUMBER_BLACKLISTED “BLACKLISTED”
NUMBER_USER_BLACKLISTED “BLACKLISTED”
SMSC_REJECTED “KO”
INVALID_CONTENTS “INVALIDCONTENTS”