PUT /virtual-numbers/{virtual-number}

Use virtual-number to update the tags and/or replyCallbackUrl of a Virtual Number.

This request body will override the original POST /virtual-numbers call.

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
`Accept`	String	Yes
`Telstra-api-version`	String	No
`Content-Type`	String	Yes
`Content-Language`	String	Yes
`Authorization`	String	Yes
`Accept-Charset`	String	Yes

Request body fields

Name Type Required Description

Name	Type	Required	Description
`replyCallbackUrl`	String	No	Tell us the URL that replies to the Virtual Number should be sent to. Note that if you don't include this field, any pre-existing replyCallbackUrl will be wiped. Sample callback response: `{ "to":"0476543210", "from":"0401234567", "timestamp":"2022-11-10T05:06:42.823Z", "messageId":"75f263c0-60b5-11ed-8456-71ae4c63550d", "messageContent":"Hi, example message", "multimedia": { "fileName":"image.jpeg", "type":"image/jpeg", "payload":"base64 payload" } }`
`tags[]`	Array	No	Create your own tags and use them to fetch, sort and report on your Virtual Numbers through our other endpoints. You can assign up to 10 tags per number. Note that if you don't include this field, any pre-existing tags will be wiped.

replyCallbackUrl

String

No

Tell us the URL that replies to the Virtual Number should be sent to.

Note that if you don't include this field, any pre-existing replyCallbackUrl will be wiped.

Sample callback response:

{
  "to":"0476543210", 
  "from":"0401234567", 
  "timestamp":"2022-11-10T05:06:42.823Z",
  "messageId":"75f263c0-60b5-11ed-8456-71ae4c63550d", 
  "messageContent":"Hi, example message", 
  "multimedia": { 
    "fileName":"image.jpeg", 
    "type":"image/jpeg", 
    "payload":"base64 payload" 
  }
}

tags[]

Array

No

Create your own tags and use them to fetch, sort and report on your Virtual Numbers through our other endpoints. You can assign up to 10 tags per number.

Note that if you don't include this field, any pre-existing tags will be wiped.

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.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy