Send a test phone notification for the configured provider

POST https://{tenantDomain}/api/v2/branding/phone/providers/{id}/try

Go

Go

package example

import (
    context "context"

    phone "github.com/auth0/go-auth0/management/management/branding/phone"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &phone.CreatePhoneProviderSendTestRequestContent{
        To: "to",
    }
    client.Branding.Phone.Providers.Test(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.branding.phone.providers.test("id", {
        to: "to",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.branding.phone.providers.test("id", {
        to: "to",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/branding/phone/providers/{id}/try \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "<string>"
}
'

import requests

url = "https://{tenantDomain}/api/v2/branding/phone/providers/{id}/try"

payload = { "to": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/branding/phone/providers/{id}/try",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'to' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/branding/phone/providers/{id}/try")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/branding/phone/providers/{id}/try")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"to\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

202

{
  "code": 123,
  "message": "<string>"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · string · requis

Required string length: 1 - 255

Corps

application/jsonapplication/x-www-form-urlencoded

to · string · requis

The recipient phone number to receive a given notification.

Required string length: 1 - 16

delivery_method · enum<string>

The delivery method for the notification

Options disponibles: text, voice

Required string length: 1 - 10

Réponse

202

application/json

Phone notification sent.

code · number

The status code of the operation.

message · string

The description of the operation status.