//[[restapi:start|RESTful API]]// ====== Message's Status ====== ===== SMS ===== {| class="table table-striped table-condensed table-bordered" ! style="background-color: lightgrey;"|Name !style="background-color: lightgrey;"|Description |- |style="width: 30%; background-color: white;"|SENT |style="width: 70%; background-color: white;"|Message sent to carrier. |- |style="width: 30%; background-color: white;"|DELIVERED_TO_CARRIER |style="width: 70%; background-color: white;"|Delivered to Carrier. |- |style="width: 30%; background-color: white;"|EXPIRED |style="width: 70%; background-color: white;"|Maximum number of tries reached. |- |style="width: 30%; background-color: white;"|UNREACHABLE |style="width: 70%; background-color: white;"|Unknown Mobile number or device id. |- |style="width: 30%; background-color: white;"|NOT_SENT |style="width: 70%; background-color: white;"|The message could not be sent. |- |style="width: 30%; background-color: white;"|BAD_FROM |style="width: 70%; background-color: white;"|Message not sent. Invalid 'from' parameter. |- |style="width: 30%; background-color: white;"|BAD_TO |style="width: 70%; background-color: white;"|Message not sent. Invalid 'to' parameter. |- |style="width: 30%; background-color: white;"|BAD_ENCODING |style="width: 70%; background-color: white;"|Message not sent. Invalid 'encoding' parameter. |- |style="width: 30%; background-color: white;"|BAD_CARRIER/FROM |style="width: 70%; background-color: white;"|Message not sent. Invalid 'carrier' or 'from' parameter. |- |style="width: 30%; background-color: white;"|SENT_TO_DEVICE |style="width: 70%; background-color: white;"|Message sent to device. |- |style="width: 30%; background-color: white;"|DELIVERED_TO_DEVICE |style="width: 70%; background-color: white;"|Message delivered to device. |- |style="width: 30%; background-color: white;"|UNDELIVERED |style="width: 70%; background-color: white;"|Message not delivered to device. |- |style="width: 30%; background-color: white;"|NOT_ENOUGH_FUNDS |style="width: 70%; background-color: white;"|Message not sent. There are not enough funds. |- |style="width: 30%; background-color: white;"|BAD_TIMEZONE |style="width: 70%; background-color: white;"|Message not sent. Invalid 'timezone'. |- |style="width: 30%; background-color: white;"|SENDING |style="width: 70%; background-color: white;"|The message is sending to the recipient. |- |style="width: 30%; background-color: white;"|PENDING |style="width: 70%; background-color: white;"|No information about the message yet |- |style="width: 30%; background-color: white;"|EXPIRED |style="width: 70%; background-color: white;"|Message not sent. Maximum number of tries reached. |- |style="width: 30%; background-color: white;"|READ |style="width: 70%; background-color: white;"|The recipient has read the message. |- |style="width: 30%; background-color: white;"|ACCEPTD |style="width: 70%; background-color: white;"|External entity confirmation - Message accepted by the external entity. |- |style="width: 30%; background-color: white;"|BAD ADDRESS |style="width: 70%; background-color: white;"|Invalid or Incorrect destination address. |- |style="width: 30%; background-color: white;"|BUFFRED |style="width: 70%; background-color: white;"|Message buffered by the external entity. |- |style="width: 30%; background-color: white;"|CARRIER GATEWAY ERROR |style="width: 70%; background-color: white;"|External entity not responding - Usually delivery will be re-attempted. |- |style="width: 30%; background-color: white;"|DELETED |style="width: 70%; background-color: white;"|Message deleted by the external entity. |- |style="width: 30%; background-color: white;"|DELIVERED TO CARRIER |style="width: 70%; background-color: white;"|Message delivered to the external entity. |- |style="width: 30%; background-color: white;"|DELIVRD |style="width: 70%; background-color: white;"|Delivered to Device by the external entity. |- |style="width: 30%; background-color: white;"|EXPIRED |style="width: 70%; background-color: white;"|Message expired by the external entity. |- |style="width: 30%; background-color: white;"|INTERNAL ERROR |style="width: 70%; background-color: white;"|Internal Error. Customer to retry delivery. |- |style="width: 30%; background-color: white;"|INVALID ROUTING |style="width: 70%; background-color: white;"|Invalid or Incorrect routing. |- |style="width: 30%; background-color: white;"|INVALID TEMPLATE ID |style="width: 70%; background-color: white;"|Invalid Template Id. |- |style="width: 30%; background-color: white;"|INVALID TEMPLATE PARAMETERS |style="width: 70%; background-color: white;"|Invalid Template parameters. |- |style="width: 30%; background-color: white;"|INVALID TEMPLATE TYPE |style="width: 70%; background-color: white;"|Invalid Template type. |- |style="width: 30%; background-color: white;"|REJECTD |style="width: 70%; background-color: white;"|External entity error - Message rejected by the external entity. |- |style="width: 30%; background-color: white;"|TEMPLATE NOT SUPPORTED |style="width: 70%; background-color: white;"|Template not supported. |- |style="width: 30%; background-color: white;"|UNDELIV |style="width: 70%; background-color: white;"|Message delivery failed at external entity. |- |style="width: 30%; background-color: white;"|UNDELIV- INTERIM |style="width: 70%; background-color: white;"|Message will be retried by carrier. |- |style="width: 30%; background-color: white;"|MESSAGE VALIDITY EXPIRED |style="width: 70%; background-color: white;"|Validity Period expired for MT message as per Validity Period parameter received. |} ===== EMAIL ===== {| class="table table-striped table-condensed table-bordered" ! style="background-color: lightgrey;"|Name !style="background-color: lightgrey;"|Description |- |style="width: 30%; background-color: white;"|SENT |style="width: 70%; background-color: white;"|Sent to recipient. |- |style="width: 30%; background-color: white;"|EXPIRED |style="width: 70%; background-color: white;"|Maximum number of tries reached. |- |style="width: 30%; background-color: white;"|NOT_SENT |style="width: 70%; background-color: white;"|The message could not be sent. |- |style="width: 30%; background-color: white;"|BAD_FROM |style="width: 70%; background-color: white;"|Message not sent. Invalid 'from' parameter. |- |style="width: 30%; background-color: white;"|BAD_TO |style="width: 70%; background-color: white;"|Message not sent. Invalid 'to' parameter. |- |style="width: 30%; background-color: white;"|BAD_ENCODING |style="width: 70%; background-color: white;"|Message not sent. Invalid 'encoding' parameter. |- |style="width: 30%; background-color: white;"|NOT_ENOUGH_FUNDS |style="width: 70%; background-color: white;"|Message not sent. There are not enough funds. |- |style="width: 30%; background-color: white;"|BAD_TIMEZONE |style="width: 70%; background-color: white;"|Message not sent. Invalid 'timezone'. |- |style="width: 30%; background-color: white;"|SENDING |style="width: 70%; background-color: white;"|The message is sending to the recipient. |- |style="width: 30%; background-color: white;"|EXPIRED |style="width: 70%; background-color: white;"|Message not sent. Maximum number of tries reached. |- |style="width: 30%; background-color: white;"|BOUNCED |style="width: 70%; background-color: white;"|Message not delivered. Invalid 'to' parameter or there has been a problem with the recipient's mail server. |- |style="width: 30%; background-color: white;"|COMPLAINED |style="width: 70%; background-color: white;"|Message not delivered. The message could have been marked and registered by the recipient as spam. |- |style="width: 30%; background-color: white;"|READ |style="width: 70%; background-color: white;"|The recipient has read the message. |- |style="width: 30%; background-color: white;"|UNSUPPORTED_ATTACHMENT_TYPE |style="width: 70%; background-color: white;"|The attachment type is not supported. |- |style="width: 30%; background-color: white;"|EXCEEDS_SIZE_OF_ATTACHMENTS |style="width: 70%; background-color: white;"|Exceeds size for the attachments (9.0 mb max). |} ===== PUSH ===== {| class="table table-striped table-condensed table-bordered" ! style="background-color: lightgrey;"|Name !style="background-color: lightgrey;"|Description |- |style="width: 30%; background-color: white;"|SENT |style="width: 70%; background-color: white;"|Sent to Carrier. |- |style="width: 30%; background-color: white;"|EXPIRED |style="width: 70%; background-color: white;"|Maximum number of tries reached. |- |style="width: 30%; background-color: white;"|UNREACHABLE |style="width: 70%; background-color: white;"|Unknown Mobile number or device id. |- |style="width: 30%; background-color: white;"|NOT_SENT |style="width: 70%; background-color: white;"|The message could not be sent. |- |style="width: 30%; background-color: white;"|NOT_ENOUGH_FUNDS |style="width: 70%; background-color: white;"|Message not sent. There are not enough funds. |- |style="width: 30%; background-color: white;"|SENDING |style="width: 70%; background-color: white;"|The message is sending to the recipient. |- |style="width: 30%; background-color: white;"|PENDING |style="width: 70%; background-color: white;"|The message is about to be sent |- |style="width: 30%; background-color: white;"|EXPIRED |style="width: 70%; background-color: white;"|Message not sent. Maximum number of tries reached. |- |style="width: 30%; background-color: white;"|READ |style="width: 70%; background-color: white;"|The recipient has read the message. |- |style="width: 30%; background-color: white;"|DELIVERED_TO_DEVICE |style="width: 70%; background-color: white;"|The recipient has received the message. |} ===== BLAST ===== {| class="table table-striped table-condensed table-bordered" ! style="background-color: lightgrey;"|Name !style="background-color: lightgrey;"|Description |- |style="width: 30%; background-color: white;"|MISSING_PARAMETERS |style="width: 70%; background-color: white;"|Blast not sent. Missing Parameters. |- |style="width: 30%; background-color: white;"|NOT_ENOUGH_FUNDS |style="width: 70%; background-color: white;"|Blast not sent. There are not enough funds. |- |style="width: 30%; background-color: white;"|PAUSED |style="width: 70%; background-color: white;"|The current blast in progress has been paused. |- |style="width: 30%; background-color: white;"|SUSPENDED |style="width: 70%; background-color: white;"|The blast scheduled has been suspended |- |style="width: 30%; background-color: white;"|SCHEDULED |style="width: 70%; background-color: white;"|Blast scheduled for a future date. |- |style="width: 30%; background-color: white;"|SENDING |style="width: 70%; background-color: white;"|Scheduled blast is sending now. |- |style="width: 30%; background-color: white;"|FINISHED |style="width: 70%; background-color: white;"|The blast has finished. |- |style="width: 30%; background-color: white;"|ABORTED |style="width: 70%; background-color: white;"|The blast has been aborted and deleted your schedule. |- |style="width: 30%; background-color: white;"|INTERRUPTED |style="width: 70%; background-color: white;"|The current blast in progress has been interrupted due to an unexpected error. |} ===== LOCATION ===== {| class="table table-striped table-condensed table-bordered" ! style="background-color: lightgrey;"|Name !style="background-color: lightgrey;"|Description |- |style="width: 30%; background-color: white;"|ENTER |style="width: 70%; background-color: white;"|The user's device entered to the fence (Beacon and Geofence). |- |style="width: 30%; background-color: white;"|EXIT |style="width: 70%; background-color: white;"|The user's device left the fence (Beacon and Geofence). |- |}