POST /virtual-numbers

When a recipient receives your message, you can choose whether they'll see a Virtual Number or senderName (paid plans only) in the from field. If you want to use a Virtual Number, use this endpoint to assign one. Free Trial users can assign one Virtual Number, and those on a paid plan can assign up to 20. If you need more than 20 virtual numbers on a paid plan, please contact us at telstradev@team.telstra.com

Virtual Numbers that have not sent a message in 30 days (Free Trial) or sent/received a message in 18 months (paid plans) will be automatically unassigned from your account. You can check the lastUse date of your Virtual Number at any time using GET /virtual-numbers/{virtual-number}.

Servers

• https://products.api.telstra.com/messaging/v3

Request headers

Request body fields

{
  "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"
  }
}

How to start integrating

1. Add HTTP Task to your workflow definition.
2. 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.
3. Click Test request to test run your request to the API and see the API's response.