--- title: Create Phone Delivery Settings (Syniverse) description: The POST {{apiPath}}/v1/environments/{{envID}}/notificationsSettings/phoneDeliverySettings endpoint creates a Syniverse phone delivery setting for the specified environment. component: pingone-api page_id: pingone-api:platform:notifications/phone-delivery-settings/create-phone-delivery-settings-syniverse canonical_url: https://developer.pingidentity.com/pingone-api/platform/notifications/phone-delivery-settings/create-phone-delivery-settings-syniverse.html section_ids: prerequisites: Prerequisites headers: Headers body: Body example-request: Example Request example-response: Example Response --- # Create Phone Delivery Settings (Syniverse) ## ```none POST {{apiPath}}/v1/environments/{{envID}}/notificationsSettings/phoneDeliverySettings ``` The `POST {{apiPath}}/v1/environments/{{envID}}/notificationsSettings/phoneDeliverySettings` endpoint creates a Syniverse phone delivery setting for the specified environment. ### Prerequisites * Refer to [Notifications](../../notifications.html) and [Phone Delivery Settings](../phone-delivery-settings.html) for important overview information. > **Collapse: Request Model** > > | Property | Type | Required? | > | ----------- | ------ | --------- | > | `authToken` | String | Required | > | `provider` | String | Required | > > Refer to the [Phone delivery settings data models](../phone-delivery-settings.html) for full property descriptions. ### Headers Authorization      Bearer {{accessToken}} Content-Type      application/json ### Body raw ( application/json ) ```json { "authToken": "exampleAuthToken", "provider": "CUSTOM_SYNIVERSE" } ``` ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/notificationsSettings/phoneDeliverySettings' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{accessToken}}' \ --data '{ "authToken": "exampleAuthToken", "provider": "CUSTOM_SYNIVERSE" }' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/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" + @" ""authToken"": ""exampleAuthToken""," + "\n" + @" ""provider"": ""CUSTOM_SYNIVERSE""" + "\n" + @"}"; request.AddStringBody(body, DataFormat.Json); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "{{apiPath}}/v1/environments/{{envID}}/notificationsSettings/phoneDeliverySettings" method := "POST" payload := strings.NewReader(`{ "authToken": "exampleAuthToken", "provider": "CUSTOM_SYNIVERSE" }`) 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)) } ``` ```http POST /v1/environments/{{envID}}/notificationsSettings/phoneDeliverySettings HTTP/1.1 Host: {{apiPath}} Content-Type: application/json Authorization: Bearer {{accessToken}} { "authToken": "exampleAuthToken", "provider": "CUSTOM_SYNIVERSE" } ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\n \"authToken\": \"exampleAuthToken\",\n \"provider\": \"CUSTOM_SYNIVERSE\"\n}"); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envID}}/notificationsSettings/phoneDeliverySettings") .method("POST", body) .addHeader("Content-Type", "application/json") .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/notificationsSettings/phoneDeliverySettings", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "Authorization": "Bearer {{accessToken}}" }, "data": JSON.stringify({ "authToken": "exampleAuthToken", "provider": "CUSTOM_SYNIVERSE" }), }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'POST', 'url': '{{apiPath}}/v1/environments/{{envID}}/notificationsSettings/phoneDeliverySettings', 'headers': { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' }, body: JSON.stringify({ "authToken": "exampleAuthToken", "provider": "CUSTOM_SYNIVERSE" }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests import json url = "{{apiPath}}/v1/environments/{{envID}}/notificationsSettings/phoneDeliverySettings" payload = json.dumps({ "authToken": "exampleAuthToken", "provider": "CUSTOM_SYNIVERSE" }) headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/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 "authToken": "exampleAuthToken",\n "provider": "CUSTOM_SYNIVERSE"\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(); } ``` ```ruby require "uri" require "json" require "net/http" url = URI("{{apiPath}}/v1/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({ "authToken": "exampleAuthToken", "provider": "CUSTOM_SYNIVERSE" }) response = http.request(request) puts response.read_body ``` ```swift let parameters = "{\n \"authToken\": \"exampleAuthToken\",\n \"provider\": \"CUSTOM_SYNIVERSE\"\n}" let postData = parameters.data(using: .utf8) var request = URLRequest(url: URL(string: "{{apiPath}}/v1/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 ```json { "_links": { "self": { "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsSettings/phoneDeliverySettings/2c39f0c2-5e58-42c6-8561-926b1c1e6028" }, "environment": { "href": "http://api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsSettings" } }, "id": "2c39f0c2-5e58-42c6-8561-926b1c1e6028", "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "createdAt": "2020-05-19T10:25:23.319Z", "updatedAt": "2020-05-19T10:25:23.319Z", "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": "SHORT_CODE", "selected": false, "available": true, "createdAt": "2020-05-19T10:25:23.828Z", "number": "894546", "capabilities": [ "SMS" ] } ], "provider": "CUSTOM_SYNIVERSE" } ```