Mission Control API: Message detail record request
Using the API is an alternative way to configure and use your Mission Control account. This can be useful if you are interested in writing programs to explore and automate the use of our features.
In this guide we will give you an example of using our API docs GUI. Hopefully this will give you a base for writing programs to interact with our API.
Before we begin, we must tell the API our credentials so the API knows which portal account we will be using it with (and who we are).
For how to do this, please refer to our article on "Authentication and Tokens". After updating your credentials you can follow on from here.
In this article you will learn how to:
- Return all mdr_requests that the user has access to
- Create a new mdr_request
- Delete an MDR Request
- Get the status of an MDR request
Please note: everything below applies ONLY to SMS compatible numbers
Return all mdr_requests that the user has access to
For every sent or received message, an MDR (message detail record) will be written. This action will return all mdr_requests that the user has access to by simply specifying the page number of results to load and also how many results per page, then clicking on the "TRY IT OUT". Please see screen print below of sample request and sample response:
Create a new mdr_request
This creates a new mdr as per the specified times in the parameters section. To do this, double click on the sample body which is to the right hand side of the parameters box: this will copy over to the parameters box where you can edit as required, then click on the "TRY IT OUT" button. Please find the screen print below for parameters and response respectively:
The minimum requirements will be the start and end times, all other ones are optional
The 'filters' field specifies a list of query criteria as follows:
Note: The first object in the filter list must specify a filter_type of "and". You can not follow an "or" with another "and". Other than that, you can specify as many filters as you like in any order.
Once your ready hit "TRY IT OUT", you should get a response similar to the one below format:
Please note MDR's are available for 30 days
Delete an MDR Request
This action deletes an MDR request by simply providing the mdr id gotten from when you created the mdr request. To do this simply input the mdr id and click the "TRY IT NOW' button. Please see screen print of sample parameters and sample response below:
The response below show there was no record found for the specified mdr and hence "false", otherwise it will be "true"
Get the status of an MDR request
This returns the status of an MDR request. Response includes a link to the report once it is generated.
To do this simply input the id of the mdr to retrieve and hit the "TRY IT OUT" button. Please see screen print of sample input and output below:
Can't find what you're looking for? Click the chat bubble at your lower right hand corner and start a chat!