Read All Phone Delivery Settings

GET {{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings

The GET {{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings endpoint returns all phone delivery settings for a specified environment.

You can include the expand query parameter set to twilioverifytemplates if you want the response to also include the relevant information for all of the Twilio Verify templates associated with your Twilio account. You’ll need this information when creating SMS/Voice notification content that uses a Verify template. Refer to the Create SMS Content (including Twilio Verify template) example.

Headers

Authorization Bearer {{accessToken}}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings' \
--header 'Authorization: Bearer {{accessToken}}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

GET /environments/{{envID}}/notificationsSettings/phoneDeliverySettings HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests

url = "{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

require "uri"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

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

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsSettings/phoneDeliverySettings/someTwilioPhoneDeliverySettingsId"
        },
        "environment": {
            "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "_embedded": {
        "phoneDeliverySettings": [
            {
                "_links": {
                    "self": {
                        "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsSettings/phoneDeliverySettings/someTwilioPhoneDeliverySettingsId"
                    },
                    "environment": {
                        "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    }
                },
                "id": "cf30debb-dfdd-45c8-9cc4-18f266a0951e",
                "environment": {
                    "id": "cf30debb-dfdd-45c8-9cc4-18f266a0951e"
                },
                "sid": "ACfbe767a5f1131a2912b28dcb07ace418",
                "numbers": [
                    {
                        "type": "PHONE_NUMBER",
                        "selected": false,
                        "available": true,
                        "createdAt": "2020-05-19T10:25:23.828Z",
                        "number": "+12024706245",
                        "capabilities": [
                            "SMS",
                            "VOICE"
                        ]
                    },
                    {
                        "type": "PHONE_NUMBER",
                        "selected": false,
                        "available": true,
                        "createdAt": "2020-05-19T10:25:23.828Z",
                        "number": "+13462445724",
                        "capabilities": [
                            "SMS",
                            "VOICE"
                        ]
                    },
                    {
                        "type": "TOLL_FREE",
                        "selected": false,
                        "available": true,
                        "createdAt": "2020-05-19T10:25:23.828Z",
                        "number": "+18449840672",
                        "capabilities": [
                            "SMS",
                            "VOICE"
                        ]
                    },
                    {
                        "type": "PHONE_NUMBER",
                        "selected": false,
                        "available": true,
                        "createdAt": "2020-05-19T10:25:23.828Z",
                        "number": "+13025817557",
                        "capabilities": [
                            "SMS",
                            "VOICE"
                        ]
                    },
                    {
                        "type": "PHONE_NUMBER",
                        "selected": false,
                        "available": true,
                        "createdAt": "2020-05-19T10:25:23.828Z",
                        "number": "+972521209508",
                        "capabilities": [
                            "SMS",
                            "VOICE"
                        ]
                    },
                    {
                        "type": "PHONE_NUMBER",
                        "selected": false,
                        "available": true,
                        "createdAt": "2020-05-19T10:25:23.828Z",
                        "number": "+61488846054",
                        "capabilities": [
                            "SMS",
                            "VOICE"
                        ]
                    },
                    {
                        "type": "PHONE_NUMBER",
                        "selected": false,
                        "available": true,
                        "createdAt": "2020-05-19T10:25:23.828Z",
                        "number": "+19182157058",
                        "capabilities": [
                            "SMS",
                            "VOICE"
                        ]
                    }
                ],
                "provider": "BYO_TWILIO"
            }
        ]
    },
    "size": 1
}

PingOne Platform APIs

Read All Phone Delivery Settings

Headers

Example Request

Example Response