PingOne Platform APIs

Create Phone Delivery Settings (custom, OAUTH2)

 

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

This example uses POST {{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings to define a custom provider for SMS and voice notifications.

As can be seen in the authentication object, OAUTH2 is used for authentication with the provider.

Prerequisites

Request Model
Property Type Required?

authentication.authUrl

String

Required

authentication.clientId

String

Required

authentication.clientSecret

String

Required

authentication.method

String

Required

default

Boolean

Optional

name

String

Required

numbers

Array

Required

provider

String

Required

requests.deliveryMethod

String

Required

requests.messageType

String

Required

requests.method

String

Required

requests.url

String

Required

See the Phone delivery settings data models for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
  "name": "CustomProviderOAUTH2",
  "provider":"CUSTOM_PROVIDER",
  "authentication": {
        "authUrl": "https://login.example.com/oauth/token",
        "clientId": "idForAccount",
        "clientSecret": "{{customProviderClientSecret}}",
        "method": "OAUTH2"
    },
  "requests":[{
      "deliveryMethod":"SMS",
      "url":"https://example.com/message",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    },
  {
      "deliveryMethod":"VOICE",
      "url":"https://example.com/voice",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    }],
    "numbers":[
        {"type":"PHONE_NUMBER",
        "number":"+1 222 333",
        "selected": true,
        "available": true,
        "capabilities":["SMS", "VOICE"]
        },
        {"type": "TOLL_FREE",
        "number": "+18544440099",
        "selected": false,
        "available": true,
        "capabilities": ["SMS", "VOICE"],
        "supportedCountries": ["US", "CA"]
        }
    ]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
  "name": "CustomProviderOAUTH2",
  "provider":"CUSTOM_PROVIDER",
  "authentication": {
        "authUrl": "https://login.example.com/oauth/token",
        "clientId": "idForAccount",
        "clientSecret": "{{customProviderClientSecret}}",
        "method": "OAUTH2"
    },
  "requests":[{
      "deliveryMethod":"SMS",
      "url":"https://example.com/message",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    },
  {
      "deliveryMethod":"VOICE",
      "url":"https://example.com/voice",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    }],
    "numbers":[
        {"type":"PHONE_NUMBER",
        "number":"+1 222 333",
        "selected": true,
        "available": true,
        "capabilities":["SMS", "VOICE"]
        },
        {"type": "TOLL_FREE",
        "number": "+18544440099",
        "selected": false,
        "available": true,
        "capabilities": ["SMS", "VOICE"],
        "supportedCountries": ["US", "CA"]
        }
    ]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"  ""name"": ""CustomProviderOAUTH2""," + "\n" +
@"  ""provider"":""CUSTOM_PROVIDER""," + "\n" +
@"  ""authentication"": {" + "\n" +
@"        ""authUrl"": ""https://login.example.com/oauth/token""," + "\n" +
@"        ""clientId"": ""idForAccount""," + "\n" +
@"        ""clientSecret"": ""{{customProviderClientSecret}}""," + "\n" +
@"        ""method"": ""OAUTH2""" + "\n" +
@"    }," + "\n" +
@"  ""requests"":[{" + "\n" +
@"      ""deliveryMethod"":""SMS""," + "\n" +
@"      ""url"":""https://example.com/message""," + "\n" +
@"      ""method"":""POST""," + "\n" +
@"      ""messageType"":""ARN&message=${message}&phoneNumber=${to}&sender=${from}""" + "\n" +
@"    }," + "\n" +
@"  {" + "\n" +
@"      ""deliveryMethod"":""VOICE""," + "\n" +
@"      ""url"":""https://example.com/voice""," + "\n" +
@"      ""method"":""POST""," + "\n" +
@"      ""messageType"":""ARN&message=${message}&phoneNumber=${to}&sender=${from}""" + "\n" +
@"    }]," + "\n" +
@"    ""numbers"":[" + "\n" +
@"        {""type"":""PHONE_NUMBER""," + "\n" +
@"        ""number"":""+1 222 333""," + "\n" +
@"        ""selected"": true," + "\n" +
@"        ""available"": true," + "\n" +
@"        ""capabilities"":[""SMS"", ""VOICE""]" + "\n" +
@"        }," + "\n" +
@"        {""type"": ""TOLL_FREE""," + "\n" +
@"        ""number"": ""+18544440099""," + "\n" +
@"        ""selected"": false," + "\n" +
@"        ""available"": true," + "\n" +
@"        ""capabilities"": [""SMS"", ""VOICE""]," + "\n" +
@"        ""supportedCountries"": [""US"", ""CA""]" + "\n" +
@"        }" + "\n" +
@"    ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

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

  payload := strings.NewReader(`{
  "name": "CustomProviderOAUTH2",
  "provider":"CUSTOM_PROVIDER",
  "authentication": {
        "authUrl": "https://login.example.com/oauth/token",
        "clientId": "idForAccount",
        "clientSecret": "{{customProviderClientSecret}}",
        "method": "OAUTH2"
    },
  "requests":[{
      "deliveryMethod":"SMS",
      "url":"https://example.com/message",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    },
  {
      "deliveryMethod":"VOICE",
      "url":"https://example.com/voice",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    }],
    "numbers":[
        {"type":"PHONE_NUMBER",
        "number":"+1 222 333",
        "selected": true,
        "available": true,
        "capabilities":["SMS", "VOICE"]
        },
        {"type": "TOLL_FREE",
        "number": "+18544440099",
        "selected": false,
        "available": true,
        "capabilities": ["SMS", "VOICE"],
        "supportedCountries": ["US", "CA"]
        }
    ]
}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  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))
}
POST /environments/{{envID}}/notificationsSettings/phoneDeliverySettings HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
  "name": "CustomProviderOAUTH2",
  "provider":"CUSTOM_PROVIDER",
  "authentication": {
        "authUrl": "https://login.example.com/oauth/token",
        "clientId": "idForAccount",
        "clientSecret": "{{customProviderClientSecret}}",
        "method": "OAUTH2"
    },
  "requests":[{
      "deliveryMethod":"SMS",
      "url":"https://example.com/message",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    },
  {
      "deliveryMethod":"VOICE",
      "url":"https://example.com/voice",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    }],
    "numbers":[
        {"type":"PHONE_NUMBER",
        "number":"+1 222 333",
        "selected": true,
        "available": true,
        "capabilities":["SMS", "VOICE"]
        },
        {"type": "TOLL_FREE",
        "number": "+18544440099",
        "selected": false,
        "available": true,
        "capabilities": ["SMS", "VOICE"],
        "supportedCountries": ["US", "CA"]
        }
    ]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"name\": \"CustomProviderOAUTH2\",\n  \"provider\":\"CUSTOM_PROVIDER\",\n  \"authentication\": {\n        \"authUrl\": \"https://login.example.com/oauth/token\",\n        \"clientId\": \"idForAccount\",\n        \"clientSecret\": \"{{customProviderClientSecret}}\",\n        \"method\": \"OAUTH2\"\n    },\n  \"requests\":[{\n      \"deliveryMethod\":\"SMS\",\n      \"url\":\"https://example.com/message\",\n      \"method\":\"POST\",\n      \"messageType\":\"ARN&message=${message}&phoneNumber=${to}&sender=${from}\"\n    },\n  {\n      \"deliveryMethod\":\"VOICE\",\n      \"url\":\"https://example.com/voice\",\n      \"method\":\"POST\",\n      \"messageType\":\"ARN&message=${message}&phoneNumber=${to}&sender=${from}\"\n    }],\n    \"numbers\":[\n        {\"type\":\"PHONE_NUMBER\",\n        \"number\":\"+1 222 333\",\n        \"selected\": true,\n        \"available\": true,\n        \"capabilities\":[\"SMS\", \"VOICE\"]\n        },\n        {\"type\": \"TOLL_FREE\",\n        \"number\": \"+18544440099\",\n        \"selected\": false,\n        \"available\": true,\n        \"capabilities\": [\"SMS\", \"VOICE\"],\n        \"supportedCountries\": [\"US\", \"CA\"]\n        }\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "CustomProviderOAUTH2",
    "provider": "CUSTOM_PROVIDER",
    "authentication": {
      "authUrl": "https://login.example.com/oauth/token",
      "clientId": "idForAccount",
      "clientSecret": "{{customProviderClientSecret}}",
      "method": "OAUTH2"
    },
    "requests": [
      {
        "deliveryMethod": "SMS",
        "url": "https://example.com/message",
        "method": "POST",
        "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
      },
      {
        "deliveryMethod": "VOICE",
        "url": "https://example.com/voice",
        "method": "POST",
        "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
      }
    ],
    "numbers": [
      {
        "type": "PHONE_NUMBER",
        "number": "+1 222 333",
        "selected": true,
        "available": true,
        "capabilities": [
          "SMS",
          "VOICE"
        ]
      },
      {
        "type": "TOLL_FREE",
        "number": "+18544440099",
        "selected": false,
        "available": true,
        "capabilities": [
          "SMS",
          "VOICE"
        ],
        "supportedCountries": [
          "US",
          "CA"
        ]
      }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "CustomProviderOAUTH2",
    "provider": "CUSTOM_PROVIDER",
    "authentication": {
      "authUrl": "https://login.example.com/oauth/token",
      "clientId": "idForAccount",
      "clientSecret": "{{customProviderClientSecret}}",
      "method": "OAUTH2"
    },
    "requests": [
      {
        "deliveryMethod": "SMS",
        "url": "https://example.com/message",
        "method": "POST",
        "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
      },
      {
        "deliveryMethod": "VOICE",
        "url": "https://example.com/voice",
        "method": "POST",
        "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
      }
    ],
    "numbers": [
      {
        "type": "PHONE_NUMBER",
        "number": "+1 222 333",
        "selected": true,
        "available": true,
        "capabilities": [
          "SMS",
          "VOICE"
        ]
      },
      {
        "type": "TOLL_FREE",
        "number": "+18544440099",
        "selected": false,
        "available": true,
        "capabilities": [
          "SMS",
          "VOICE"
        ],
        "supportedCountries": [
          "US",
          "CA"
        ]
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

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

payload = json.dumps({
  "name": "CustomProviderOAUTH2",
  "provider": "CUSTOM_PROVIDER",
  "authentication": {
    "authUrl": "https://login.example.com/oauth/token",
    "clientId": "idForAccount",
    "clientSecret": "{{customProviderClientSecret}}",
    "method": "OAUTH2"
  },
  "requests": [
    {
      "deliveryMethod": "SMS",
      "url": "https://example.com/message",
      "method": "POST",
      "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    },
    {
      "deliveryMethod": "VOICE",
      "url": "https://example.com/voice",
      "method": "POST",
      "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    }
  ],
  "numbers": [
    {
      "type": "PHONE_NUMBER",
      "number": "+1 222 333",
      "selected": True,
      "available": True,
      "capabilities": [
        "SMS",
        "VOICE"
      ]
    },
    {
      "type": "TOLL_FREE",
      "number": "+18544440099",
      "selected": False,
      "available": True,
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "supportedCountries": [
        "US",
        "CA"
      ]
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", 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_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n  "name": "CustomProviderOAUTH2",\n  "provider":"CUSTOM_PROVIDER",\n  "authentication": {\n        "authUrl": "https://login.example.com/oauth/token",\n        "clientId": "idForAccount",\n        "clientSecret": "{{customProviderClientSecret}}",\n        "method": "OAUTH2"\n    },\n  "requests":[{\n      "deliveryMethod":"SMS",\n      "url":"https://example.com/message",\n      "method":"POST",\n      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"\n    },\n  {\n      "deliveryMethod":"VOICE",\n      "url":"https://example.com/voice",\n      "method":"POST",\n      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"\n    }],\n    "numbers":[\n        {"type":"PHONE_NUMBER",\n        "number":"+1 222 333",\n        "selected": true,\n        "available": true,\n        "capabilities":["SMS", "VOICE"]\n        },\n        {"type": "TOLL_FREE",\n        "number": "+18544440099",\n        "selected": false,\n        "available": true,\n        "capabilities": ["SMS", "VOICE"],\n        "supportedCountries": ["US", "CA"]\n        }\n    ]\n}');
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 "json"
require "net/http"

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

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "name": "CustomProviderOAUTH2",
  "provider": "CUSTOM_PROVIDER",
  "authentication": {
    "authUrl": "https://login.example.com/oauth/token",
    "clientId": "idForAccount",
    "clientSecret": "{{customProviderClientSecret}}",
    "method": "OAUTH2"
  },
  "requests": [
    {
      "deliveryMethod": "SMS",
      "url": "https://example.com/message",
      "method": "POST",
      "messageType": "ARN&message=\${message}&phoneNumber=\${to}&sender=\${from}"
    },
    {
      "deliveryMethod": "VOICE",
      "url": "https://example.com/voice",
      "method": "POST",
      "messageType": "ARN&message=\${message}&phoneNumber=\${to}&sender=\${from}"
    }
  ],
  "numbers": [
    {
      "type": "PHONE_NUMBER",
      "number": "+1 222 333",
      "selected": true,
      "available": true,
      "capabilities": [
        "SMS",
        "VOICE"
      ]
    },
    {
      "type": "TOLL_FREE",
      "number": "+18544440099",
      "selected": false,
      "available": true,
      "capabilities": [
        "SMS",
        "VOICE"
      ],
      "supportedCountries": [
        "US",
        "CA"
      ]
    }
  ]
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"name\": \"CustomProviderOAUTH2\",\n  \"provider\":\"CUSTOM_PROVIDER\",\n  \"authentication\": {\n        \"authUrl\": \"https://login.example.com/oauth/token\",\n        \"clientId\": \"idForAccount\",\n        \"clientSecret\": \"{{customProviderClientSecret}}\",\n        \"method\": \"OAUTH2\"\n    },\n  \"requests\":[{\n      \"deliveryMethod\":\"SMS\",\n      \"url\":\"https://example.com/message\",\n      \"method\":\"POST\",\n      \"messageType\":\"ARN&message=${message}&phoneNumber=${to}&sender=${from}\"\n    },\n  {\n      \"deliveryMethod\":\"VOICE\",\n      \"url\":\"https://example.com/voice\",\n      \"method\":\"POST\",\n      \"messageType\":\"ARN&message=${message}&phoneNumber=${to}&sender=${from}\"\n    }],\n    \"numbers\":[\n        {\"type\":\"PHONE_NUMBER\",\n        \"number\":\"+1 222 333\",\n        \"selected\": true,\n        \"available\": true,\n        \"capabilities\":[\"SMS\", \"VOICE\"]\n        },\n        {\"type\": \"TOLL_FREE\",\n        \"number\": \"+18544440099\",\n        \"selected\": false,\n        \"available\": true,\n        \"capabilities\": [\"SMS\", \"VOICE\"],\n        \"supportedCountries\": [\"US\", \"CA\"]\n        }\n    ]\n}"
let postData = parameters.data(using: .utf8)

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

request.httpMethod = "POST"
request.httpBody = postData

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

201 Created

{
    "_links": {
        "self": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsSettings/phoneDeliverySettings/10520e48-3d04-49bf-bcf7-2e0300f81abb"
        },
        "environment": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "id": "10520e48-3d04-49bf-bcf7-2e0300f81abb",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "CustomProviderOAUTH2",
    "createdAt": "2025-06-09T13:53:48.945Z",
    "updatedAt": "2025-06-09T13:53:48.945Z",
    "provider": "CUSTOM_PROVIDER",
    "numbers": [
        {
            "type": "PHONE_NUMBER",
            "selected": true,
            "available": true,
            "number": "+1 222 333",
            "capabilities": [
                "SMS",
                "VOICE"
            ]
        },
        {
            "supportedCountries": [
                "US",
                "CA"
            ],
            "type": "TOLL_FREE",
            "selected": false,
            "available": true,
            "number": "+18544440099",
            "capabilities": [
                "SMS",
                "VOICE"
            ]
        }
    ],
    "authentication": {
        "grantType": "CLIENT_CREDENTIALS",
        "clientAuthenticationMethod": "BASIC_AUTH_HEADER",
        "authUrl": "https://login.example.com/oauth/token",
        "clientId": "idForAccount",
        "method": "OAUTH2"
    },
    "requests": [
        {
            "deliveryMethod": "SMS",
            "url": "https://example.com/message",
            "method": "POST",
            "phoneNumberFormat": "FULL"
        },
        {
            "deliveryMethod": "VOICE",
            "url": "https://example.com/voice",
            "method": "POST",
            "phoneNumberFormat": "FULL"
        }
    ]
}