This article details commonly used API operations. Each section corresponds to an operation and includes a brief overview, a sample request and response payload, and schema information pulled directly from the API reference. Additionally, each section will include links to the corresponding API reference entry and any tutorials (if available).
For information on how complete the configuration steps required for this API, along with language-specific guides that illustrate the API's functionality with pre-populated examples, see the Getting started guides that correspond to this API.
Mobile Originated (MO) messages, or inbounds, are incoming messages. Inbound messages can be listed and retrieved like batch messages and they can also be delivered by callback requests like delivery reports.
This operation enables you to list all inbound messages that you have received. Results are returned in reverse chronological order meaning users will see the most recently received messages near the top of the list. This operation is highly customizable. Users can filter results by date range and to number. If there is a high volume of batches, results can be paginated. Pagination is flexible, with the page and page_size query parameters enabling users to set the number of pages and the number of results per page.
Below are code samples that highlight how to make this API request in multiple languages. A sample response is also provided. Select your preferred coding language from the language drop-down list:
- Global API
https://us.sms.api.sinch.com/xms/v1/{service_plan_id}/inbounds
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://us.sms.api.sinch.com/xms/v1/jd63jf88477ll123ab4567cd89012ef3/inbounds?page=2&page_size=30&to=%2B14155553421%2C45607&start_date=2019-08-24T14%3A15%3A22Z&end_date=2016-10-02T09%3A34%3A18.542Z&client_reference=myReference' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'For the full schema of the response that corresponds to this API call, see the corresponding entry in the API reference.
For the full schema of the response that corresponds to this API call, see the corresponding entry in the API reference.
This operation retrieves a specific inbound message with the provided inbound ID.
Below are code samples that highlight how to make this API request in multiple languages. A sample response is also provided. Select your preferred coding language from the language drop-down list:
- Global API
https://us.sms.api.sinch.com/xms/v1/{service_plan_id}/inbounds/{inbound_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://us.sms.api.sinch.com/xms/v1/jd63jf88477ll123ab4567cd89012ef3/inbounds/01FC66621XXXXX119Z8PMV1QPA \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'For the full schema of the request that corresponds to this API call, see the corresponding entry in the API reference.
For all possible response schemas that correspond to this API call, see the corresponding entry in the API reference.