Conversations
Read messages or message summaries regarding specific participants. Like conversations between you and a specific customer for example.
Messages
Read messages to and/or from a given participant.
The data returned is a paginated list of the same type of Reading messagesOrdered chronologically by creation date.
- All messages
GET /v2/conversations/{participant}
- Outgoing messages:
GET /v2/conversations/{participant}/mt
- Incoming messages
GET /v2/conversations/{participant}/mo
mt
is an acronym for mobile terminated.mo
is an acronym for mobile originated.
participant
The sender ID of the participant whose messages are listed.
Summary
Apart from reading messages to and from specific MSISDNs we also provide an endpoint which gives you an aggregated summary with mt and mo
GET v2/conversations/{participant}/summary
{ "participant": "46734487112", "totalMessageCount": 387, "totalSmsCount": 774, "mobileTerminatedMessages": { "101": { "messages": 43, "sms": 86 }, "102": { " messages": 3, "sms": 6 }, "201": { "messages": 142, "sms": 284 } }, "mobileOriginatedMessages": { "201": { "messages": 199, "sms" : 398 } } }
participant
A participant is either an MSISDN or an alphanumeric sender. This field tells what participant the summary is about.
totalMessageCount
The total number of messages with the participant.
totalSmsCount
The total number of SMS segments with the participant.
mobileTerminatedMessages
Summary of messages sent to the participant. This is a dictionary where the key is a status code and the value is the count of how many messages (and their corresponding SMS segments) has that status code as it's most recently added status.
mobileOriginatedMessages
Summary of messages sent from the participant. This is a dictionary where the key is a status code and the value is the count of how many messages (and their corresponding SMS segments) has that status code as it's most recently added status.