Skip to end of metadata
Go to start of metadata

Last Updated: Friday, January 26, 2018



GET - /MessageApi/mt/messageLists/<listid>

Get meta information about a previously requested Mobile Terminated (MT) Message List. The Vibes assigned listId is required, and is returned in the synchronous response to the original POST request for the list.

URL Request Example

https://messageapi.vibesapps.com/MessageApi/mt/messageLists/b75fccf3-8f06-4d8f-a282-d1886a4792a1

Successful XML Response Example

<mtMessageList listId="b75fccf3-8f06-4d8f-a282-d1886a4792a1"
	submitterListId="623452423424"
	submitDate="2011-04-19T15:10:08.320-05:00" 
	messageCount="2" submitSuccessCount="2" submitErrorCount="0"/>

GET - /MessageApi/mt/messageLists?submitterListId=<clientid>

Query for information about MT Message List(s). Since the submitterListId may not be unique, this method may return information from multiple lists. If multiple lists are matched, the latest matches (up to 10) will be returned in descending order by date.

URL Request Example

https://messageapi.vibesapps.com/MessageApi/mt/messageLists?submitterListId=623452423424

Successful XML Response Example

<mtMessageLists>
	<mtMessageList listId="b75fccf3-8f06-4d8f-a282-d1886a4792a1"
		submitterListId="623452423424"
		submitDate="2011-04-19T15:10:08.320-05:00"
		messageCount="2" submitSuccessCount="2" submitErrorCount="0"/>
	<mtMessageList listId="v1234jhhg-8f06-4d8f-a282-d1886a4792a1"
		submitterListId="623452423424"
		submitDate="2011-04-18T15:10:08.320-05:00"
		messageCount="2" submitSuccessCount="2" submitErrorCount="0"/>
</mtMessageLists>

Response Element Descriptions

Element

Attribute Name 

Description

Data Type 

Required

mtMessageList

 

The root element of the response.

 

Yes

 

listId

The Vibes-assigned unique identifier.

String

Yes

 

submitterListId

The client-defined identifier. If none was set on the original POST, then this attribute will not be sent.

String

No

 

submitDate

The date/time the original POST was received.

DateTime

Yes

 

messageCount

The total number of messages in the original MT Message List POST.

Integer

Yes

 

submitSuccessCount

The number of messages in the list that were successfully parsed and submitted for processing. 
Note: This does not confirm delivery to the carrier.

Integer

Yes

 

submitErrorCount

The number of messages in the list that were not successfully submitted for processing.
This count will be equal to the messageCount if the whole request failed, or the number of error elements returned in the POST response if part of the request failed. 

Integer

Yes

  • No labels