On occasion, you may want to query our APIs for data on a previous send or specific mobile number. In this article, you’ll learn how to gain meta information using URL calls.
Skip to a specific section:
- Retrieve all available information on a previous call
- Retrieve system responses on a previous send
- Retrieve information about a message that was split into multiple parts
- Retrieve carrier information for a mobile number
Retrieve all available info
Using this GET method, you can retrieve information about previous messages you’ve sent to a handset, which you can use for informational purposes or to troubleshoot a specific issue.
To perform this call, you’ll need the specific messageID for the message you’d like information on. The messageID is returned when you successfully submit a message.
Note
Our system processes asynchronously, meaning your message is not guaranteed to be available and retrievable until after the response callback has been made. Additionally, this call should be used only to retrieve a specific message for informational purposes.
Caution
This API should not be used for mass message data retrieval. If information is needed on multiple MT message status, please see our Callbacks article.
Request
Below is an example of the URL request for this information.
https://messageapi.vibesapps.com/MessageApi/mt/messages/b75fccf3-8f06-4d8f-a282-d1886a4792a2
Response
Below is an example of the response you might get to the above request. The relevant elements are defined below.
<mtMessage submitterMessageId="239487234987234"
messageId="b75fccf3-8f06-4d8f-a282-d1886a4792a2"
submitDate="2011-04-19T15:10:08.320-05:00" isMultipart="true" noOfParts="2" partNumber="1" originalMessageId="b75fccf3-8f06-4d8f-a282-d1886a4792a2">
<destination carrier="102" address="+12995551234" type="MDN" />
<source address="98765" type="SC" />
<text>123857AB12</text>
<receiptOption>ERROR</receiptOption>
</mtMessage>
mtMessage is the main wrapper element for the response to this response. The attributes are displayed in a table below. For more information about the other elements and attributes not defined here, see our article on sending an SMS message
| Attribute Name | Description | Data Type |
|---|---|---|
fwdToMessageId | If the original send utilized alternate message delivery, this attribute may appear in your response. The value will be the unique message ID of the alternate message that was sent when the original message failed. | |
fwdFromMessageId | If your send utilized alternate message delivery and the message you requested information on was not the original message, this attribute may appear in your response. The value will be the unique message ID of the original message that was attempted and failed. | |
isMultipart | Only present if equal to True, which indicates the message was split into multiple parts. | Boolean |
noOfParts | Only present if isMultipart=”true”. This string indicates the number of parts the message was split into. | String |
partNumber | Only present if isMultipart=”true”. This string indicates the number of this message’s part. | String |
originalMessageId | Only present if isMultipart=”true”. This string indicates the messageId for the original message that was split. | String |
Reference Table
The reference tables below contain the same information as above, but in a quick-reference table form.
| Element | Attribute | Description | Data Type |
|---|---|---|---|
mtMessage | The main wrapper element around the submit response. | ||
fwdToMessageId | If the original send utilized alternate message delivery this attribute may appear in your response. The value will be the unique message ID of the alternate message that was sent when the original message failed. | ||
fwdFromMessageId | If your send utilized alternate message delivery and the message you requested information on was not the original message, this attribute may appear in your response. The value will be the unique message ID of the original message that was attempted and failed. | ||
isMultipart | Only present if equal to True. True if this message is part of a multi-part message. | Boolean | |
noOfParts | Only present if isMultipart=true. This string indicates the number of parts the message was split into. | String | |
partNumber | Only present if isMultipart=true. This string indicates the number of this message’s part. | String | |
originalMessageId | Only present if isMultipart=true. This string indicates the messageId for the original message that was split. | String | |
mtMessageResponses | The wrapper element that has all the MTMESSAGERESPONSES for the MT message. | ||
mtMessageResponse | The root element of a MTMESSAGERESPONSE. | ||
messageId | The unique identifier assigned to the message when it was submitted. | String | |
submitterMessageId | The client-defined identifier for the message if set while submitting the message. | String | |
fwdToMessageId | If the original send utilized alternate message delivery, this attribute may appear in your response. The value will be the unique message ID of the alternate message that was sent when the original message failed. | ||
fwdFromMessageId | If your send utilized alternate message delivery and the message you requested information on was not the original message, this attribute may appear in your response. The value will be the unique message ID of the original message that was attempted and failed. | ||
receiptDate | Date the response was received in standard XML format. | String | |
type | The processing stage at which the response was generated. The possible values are as follows: - System: While the MTMESSAGE was being routed to the carrier by the Message API system.- Carrier: While submitting the MTMESSAGE to the carrier.- Handset: While submitting the MTMESSAGE to the handset. | String | |
status | Element that has the status of the MTMESSAGE. | ||
isError | Boolean on whether the status is an error. | Boolean | |
description | This element provides a description of the error if an error is present. If no error is present, it will read MtMessage successfully delivered to Carrier. | String | |
errorCode | If the message fails, this element contains the error code that describes the specific failure reason. See HTTP Error and Status Codes for more info. | Numeric | |
internalErrorCode | If the message fails due to a Vibes error, this element contains the exact same value as the errorcode element.If the message fails due to a carrier error, this element contains the exact error code returned by the carrier to Vibes for further research. This value can be communicated to Vibes support for more information. | Numeric | |
multipart | The wrapper element that has all information about MULTIPART (long message split into multiple parts) message. This element is present if the request had SPLITLONGMESSAGE set to True, and the original Long message got split into multiple parts. | ||
isMultipart | If the original message was multipart, this will be set to true. | Boolean | |
noOfParts | Only present if isMultipart=true. This string indicates the number of parts the message was split into. | String | |
partNumber | Only present if isMultipart=true. This string indicates the number of this message’s part. | String | |
originalMessageId | Only present if isMultipart=true. This string indicates the messageId for the original message that was split. |