PingOne Platform APIs

Update Phone Delivery Settings

 

PUT {{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}

The PUT {{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}} endpoint updates the specified phone delivery settings in a specified environment. Note the value of CUSTOM_PROVIDER assignmed to provider in the request body.

Prerequisites

Request Model
Property Type Required?

authentication.method

String

Required

authentication.password

String

Required

authentication.username

String

Required

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

Refer to the Phone delivery settings data models for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
  "name": "UPdatedCustomProviderName",
  "provider":"CUSTOM_PROVIDER",
  "authentication":{
      "method":"BASIC",
      "username":"{{username}}",
      "password":"{{password}}"
    },
  "requests":[{
      "deliveryMethod":"SMS",
      "url":"https://api-vendor.com/message",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    },
  {
      "deliveryMethod":"VOICE",
      "url":"https://api-vendor.com/voice",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    }],
    "numbers":[
        {"type":"PHONE_NUMBER",
        "number":"+1 222 333",
        "capabilities":["SMS", "VOICE"]
        }
    ]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
  "name": "UPdatedCustomProviderName",
  "provider":"CUSTOM_PROVIDER",
  "authentication":{
      "method":"BASIC",
      "username":"{{username}}",
      "password":"{{password}}"
    },
  "requests":[{
      "deliveryMethod":"SMS",
      "url":"https://api-vendor.com/message",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    },
  {
      "deliveryMethod":"VOICE",
      "url":"https://api-vendor.com/voice",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    }],
    "numbers":[
        {"type":"PHONE_NUMBER",
        "number":"+1 222 333",
        "capabilities":["SMS", "VOICE"]
        }
    ]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"  ""name"": ""UPdatedCustomProviderName""," + "\n" +
@"  ""provider"":""CUSTOM_PROVIDER""," + "\n" +
@"  ""authentication"":{" + "\n" +
@"      ""method"":""BASIC""," + "\n" +
@"      ""username"":""{{username}}""," + "\n" +
@"      ""password"":""{{password}}""" + "\n" +
@"    }," + "\n" +
@"  ""requests"":[{" + "\n" +
@"      ""deliveryMethod"":""SMS""," + "\n" +
@"      ""url"":""https://api-vendor.com/message""," + "\n" +
@"      ""method"":""POST""," + "\n" +
@"      ""messageType"":""ARN&message=${message}&phoneNumber=${to}&sender=${from}""" + "\n" +
@"    }," + "\n" +
@"  {" + "\n" +
@"      ""deliveryMethod"":""VOICE""," + "\n" +
@"      ""url"":""https://api-vendor.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" +
@"        ""capabilities"":[""SMS"", ""VOICE""]" + "\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/{{phoneDeliverySettingsID}}"
  method := "PUT"

  payload := strings.NewReader(`{
  "name": "UPdatedCustomProviderName",
  "provider":"CUSTOM_PROVIDER",
  "authentication":{
      "method":"BASIC",
      "username":"{{username}}",
      "password":"{{password}}"
    },
  "requests":[{
      "deliveryMethod":"SMS",
      "url":"https://api-vendor.com/message",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    },
  {
      "deliveryMethod":"VOICE",
      "url":"https://api-vendor.com/voice",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    }],
    "numbers":[
        {"type":"PHONE_NUMBER",
        "number":"+1 222 333",
        "capabilities":["SMS", "VOICE"]
        }
    ]
}`)

  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))
}
PUT /environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
  "name": "UPdatedCustomProviderName",
  "provider":"CUSTOM_PROVIDER",
  "authentication":{
      "method":"BASIC",
      "username":"{{username}}",
      "password":"{{password}}"
    },
  "requests":[{
      "deliveryMethod":"SMS",
      "url":"https://api-vendor.com/message",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    },
  {
      "deliveryMethod":"VOICE",
      "url":"https://api-vendor.com/voice",
      "method":"POST",
      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    }],
    "numbers":[
        {"type":"PHONE_NUMBER",
        "number":"+1 222 333",
        "capabilities":["SMS", "VOICE"]
        }
    ]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"name\": \"UPdatedCustomProviderName\",\n  \"provider\":\"CUSTOM_PROVIDER\",\n  \"authentication\":{\n      \"method\":\"BASIC\",\n      \"username\":\"{{username}}\",\n      \"password\":\"{{password}}\"\n    },\n  \"requests\":[{\n      \"deliveryMethod\":\"SMS\",\n      \"url\":\"https://api-vendor.com/message\",\n      \"method\":\"POST\",\n      \"messageType\":\"ARN&message=${message}&phoneNumber=${to}&sender=${from}\"\n    },\n  {\n      \"deliveryMethod\":\"VOICE\",\n      \"url\":\"https://api-vendor.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        \"capabilities\":[\"SMS\", \"VOICE\"]\n        }\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}")
  .method("PUT", 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/{{phoneDeliverySettingsID}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "UPdatedCustomProviderName",
    "provider": "CUSTOM_PROVIDER",
    "authentication": {
      "method": "BASIC",
      "username": "{{username}}",
      "password": "{{password}}"
    },
    "requests": [
      {
        "deliveryMethod": "SMS",
        "url": "https://api-vendor.com/message",
        "method": "POST",
        "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
      },
      {
        "deliveryMethod": "VOICE",
        "url": "https://api-vendor.com/voice",
        "method": "POST",
        "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
      }
    ],
    "numbers": [
      {
        "type": "PHONE_NUMBER",
        "number": "+1 222 333",
        "capabilities": [
          "SMS",
          "VOICE"
        ]
      }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/notificationsSettings/phoneDeliverySettings/{{phoneDeliverySettingsID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "UPdatedCustomProviderName",
    "provider": "CUSTOM_PROVIDER",
    "authentication": {
      "method": "BASIC",
      "username": "{{username}}",
      "password": "{{password}}"
    },
    "requests": [
      {
        "deliveryMethod": "SMS",
        "url": "https://api-vendor.com/message",
        "method": "POST",
        "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
      },
      {
        "deliveryMethod": "VOICE",
        "url": "https://api-vendor.com/voice",
        "method": "POST",
        "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
      }
    ],
    "numbers": [
      {
        "type": "PHONE_NUMBER",
        "number": "+1 222 333",
        "capabilities": [
          "SMS",
          "VOICE"
        ]
      }
    ]
  })

};
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/{{phoneDeliverySettingsID}}"

payload = json.dumps({
  "name": "UPdatedCustomProviderName",
  "provider": "CUSTOM_PROVIDER",
  "authentication": {
    "method": "BASIC",
    "username": "{{username}}",
    "password": "{{password}}"
  },
  "requests": [
    {
      "deliveryMethod": "SMS",
      "url": "https://api-vendor.com/message",
      "method": "POST",
      "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    },
    {
      "deliveryMethod": "VOICE",
      "url": "https://api-vendor.com/voice",
      "method": "POST",
      "messageType": "ARN&message=${message}&phoneNumber=${to}&sender=${from}"
    }
  ],
  "numbers": [
    {
      "type": "PHONE_NUMBER",
      "number": "+1 222 333",
      "capabilities": [
        "SMS",
        "VOICE"
      ]
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("PUT", 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/{{phoneDeliverySettingsID}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n  "name": "UPdatedCustomProviderName",\n  "provider":"CUSTOM_PROVIDER",\n  "authentication":{\n      "method":"BASIC",\n      "username":"{{username}}",\n      "password":"{{password}}"\n    },\n  "requests":[{\n      "deliveryMethod":"SMS",\n      "url":"https://api-vendor.com/message",\n      "method":"POST",\n      "messageType":"ARN&message=${message}&phoneNumber=${to}&sender=${from}"\n    },\n  {\n      "deliveryMethod":"VOICE",\n      "url":"https://api-vendor.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        "capabilities":["SMS", "VOICE"]\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/{{phoneDeliverySettingsID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "name": "UPdatedCustomProviderName",
  "provider": "CUSTOM_PROVIDER",
  "authentication": {
    "method": "BASIC",
    "username": "{{username}}",
    "password": "{{password}}"
  },
  "requests": [
    {
      "deliveryMethod": "SMS",
      "url": "https://api-vendor.com/message",
      "method": "POST",
      "messageType": "ARN&message=\${message}&phoneNumber=\${to}&sender=\${from}"
    },
    {
      "deliveryMethod": "VOICE",
      "url": "https://api-vendor.com/voice",
      "method": "POST",
      "messageType": "ARN&message=\${message}&phoneNumber=\${to}&sender=\${from}"
    }
  ],
  "numbers": [
    {
      "type": "PHONE_NUMBER",
      "number": "+1 222 333",
      "capabilities": [
        "SMS",
        "VOICE"
      ]
    }
  ]
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"name\": \"UPdatedCustomProviderName\",\n  \"provider\":\"CUSTOM_PROVIDER\",\n  \"authentication\":{\n      \"method\":\"BASIC\",\n      \"username\":\"{{username}}\",\n      \"password\":\"{{password}}\"\n    },\n  \"requests\":[{\n      \"deliveryMethod\":\"SMS\",\n      \"url\":\"https://api-vendor.com/message\",\n      \"method\":\"POST\",\n      \"messageType\":\"ARN&message=${message}&phoneNumber=${to}&sender=${from}\"\n    },\n  {\n      \"deliveryMethod\":\"VOICE\",\n      \"url\":\"https://api-vendor.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        \"capabilities\":[\"SMS\", \"VOICE\"]\n        }\n    ]\n}"
let postData = parameters.data(using: .utf8)

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

request.httpMethod = "PUT"
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

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsSettings/phoneDeliverySettings/96ddc06f-a586-4c50-b316-a7e104b49fd9"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "id": "96ddc06f-a586-4c50-b316-a7e104b49fd9",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "createdAt": "2021-11-24T14:38:33.435Z",
    "updatedAt": "2021-11-24T14:41:12.353Z",
    "numbers": [
        {
            "type": "PHONE_NUMBER",
            "selected": false,
            "available": false,
            "number": "+1 222 333",
            "capabilities": [
                "SMS",
                "VOICE"
            ]
        }
    ],
    "name": "UPdatedCustomProviderName",
    "authentication": {
        "username": "lindajones",
        "method": "BASIC"
    },
    "requests": [
        {
            "deliveryMethod": "SMS",
            "url": "https://api-vendor.com/message",
            "method": "POST"
        },
        {
            "deliveryMethod": "VOICE",
            "url": "https://api-vendor.com/voice",
            "method": "POST"
        }
    ],
    "provider": "CUSTOM_PROVIDER"
}