Text History
The text history Application Program Interface (API) can be used to retrieve the history of events for a given text-enabled Toll-Free Numbers (TFNs) in descending order of date and time the event occurred for that TFN. This api will return the history of events based on roles and permissions for a given user. Below are some examples:
If the user is a Resp Org and has access to the given TFN, this api will return the history of events
for that TFN. If the user does not have access to the TFN, it will return an empty list.
If the user is a Service Registrar who is currently responsible (owner SR) for a given TFN, this api
will return the history of events that are pertaining to that TFN and Service Registrar (SR) combination. The user won’t be able to get the history of events that happened before the TFN
belonged to that Service Registrar.
The following is an example REST/JSON query request to get the event history for given text-enabled
TFN:
POST /api/v2/tss-text-history HTTP/1.0
Content-Type: application/json
Content-Length: <num>
{
"id":"user",
"pwd":"password",
"tfn":"8005001212"
}
A response similar to the following is issued by Texting and Smart Services (TSS) Registry to the user on success:
// The HTTP header is omitted for brevity. The JSON portion follows:
{
"url":"/api/v2/tss-text-history", // positive confirmation
"tfn":"8005001212", // TFN
"events":[ // an array of events
{
"tfn":"8005001212",
"date":"01/12/2019 16:10:28 GMT",
"event":"<seeTableBelow>",
"rejectReasonId":null,
"ownerTspid":"12345",
"ownerSrName":"Owner SR Name",
"routingTspid":"12345",
"routingSrName":"Routing SR Name",
"roName":"Resp Org Name",
"ror":"ROR01",
"businessName":"Subscriber Business Name",
"contactName":"Subscriber Name",
"contactJobTitle":"Subscriber Job Title",
"contactPhone":"Subscriber Phone",
"contactEmail":"Subscriber Email",
"username":"username"
},
{
"tfn":"8005001212",
"date":"01/03/2019 17:31:45 GMT",
"event":"<seeTableBelow>",
"rejectReasonId":null,
"ownerTspid":"12345",
"ownerSrName":"Owner SR Name",
"routingTspid":"12345",
"routingSrName":"Routing SR Name",
"roName":"Resp Org Name",
"ror":"ROR01",
"businessName":"Subscriber Business Name",
"contactName":"Subscriber Name",
"contactJobTitle":"Subscriber Job Title",
"contactPhone":"Subscriber Phone",
"contactEmail":"Subscriber Email",
"username":"username"
}
] // end of the response array
}
Failure responses are discussed in the Error section.
The following table enumerates the possible values for the event field on a successful request.