Create a new voice service

Request

Creates a new voice service in the specified project.

Security

BasicAuth or SinchOAuth2

Path

projectIdstring, (uuid)(Project ID)required

The ID of the project.

Idempotency-Keystring, [ 16 .. 128 ] characters

Client-generated idempotency key to safely retry requests. The server uses this key to recognize retries of the same request. If a request with the same key is received within 10 minutes, the server returns the cached response from the original request. Using a random UUID (v4) is strongly recommended.

Bodyapplication/json

namestring, [ 1 .. 64 ] characters^\S+(\s+\S+)*$required

Voice service name. No leading or trailing whitespaces allowed.

Example:"My Voice Service"

descriptionstring, <= 255 characters^\S+(\s+\S+)*$

Description of the service

Example:"This is a description of my voice service"

isDefaultboolean(Service Is Default)

Indicates whether this service is set as the default for the project. The default service is used when no specific service is specified in API requests. Note: when updating a service, this property cannot be set to false. In such case, a BadRequest will be returned by the API.

callBehaviorany(Call Behaviors)

curl -i -X POST \
  -u '<username>:<password>' \
  'https://voice.api.sinch.com/v2/projects/{projectId}/services' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: stringstringstri' \
  -d '{
    "description": "Service with webhooks",
    "name": "Example service",
    "callBehavior": {
      "type": "WEBHOOK",
      "webhook": {
        "url": "https://example.com/webhook",
        "fallbackUrl": "https://example.com/fallback"
      }
    }
  }'

Responses

Service created.

Bodyapplication/json

serviceIdstring, (uuid)(Service ID)required

The ID of the service used.

projectIdstring, (uuid)(Project ID)required

The Id of the project associated with the call.

createTimestring, (date-time)read-onlyrequired

Timestamp (RFC 3339) indicating when the service was created.

Example:"2025-01-01 00:00:00+00:00"

namestring, [ 1 .. 64 ] characters^\S+(\s+\S+)*$required

Voice service name. No leading or trailing whitespaces allowed.

Example:"My Voice Service"

isDefaultboolean(Service Is Default)required

Indicates whether this service is set as the default for the project. The default service is used when no specific service is specified in API requests. Note: when updating a service, this property cannot be set to false. In such case, a BadRequest will be returned by the API.

updateTimestring, (date-time)read-only

Timestamp (RFC 3339) indicating when the service was last updated.

Omitted if no updates were performed on this service.

Example:"2025-01-01 00:00:00+00:00"

descriptionstring

Description of the service

Example:"This is a description of my voice service"

callBehaviorany(Call Behaviors)

Response

{
  "serviceId": "6e124178-c29d-46a5-943c-5c2ae544aade",
  "projectId": "5c5bf2b1-35ae-4825-ab89-457e07bb60e6",
  "createTime": "2025-01-01T00:00:00Z",
  "name": "Example service",
  "description": "Service with webhooks",
  "isDefault": false,
  "callBehavior": {
    "type": "WEBHOOK",
    "webhook": { … }
  }
}

We'd love to hear from you!