GET /virtual-numbers/{virtual-number}/optouts
Use this endpoint to fetch any mobile number(s) that have opted out of receiving messages from a Virtual Number assigned to your account.
Recipients can opt out at any time by sending a message with industry standard keywords such as STOP, STOPALL, UNSUBSCRIBE, QUIT, END and CANCEL.
Servers
- https://products.api.telstra.com/messaging/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
virtual-number |
String | Yes |
Write the Virtual Number here, using national format (e.g. 0412345678). |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes | |
Telstra-api-version |
String | No | |
Authorization |
String | Yes | |
Accept-Charset |
String | Yes |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
Integer | No |
Tell us how many results you want us to return, up to a maximum of 50. Default value: 10 |
offset |
Integer | No |
Use the offset to navigate between the response results. An offset of 0 will display the first page of results, and so on. Default value: 0 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.