Retrieve a voice service by ID

Request

Retrieve the full details of a specific voice service by its serviceId.

Security

BasicAuth or SinchOAuth2

Path

projectIdstring, (uuid)(Project ID)required

The ID of the project.

serviceIdstring, (uuid)(Service ID)required

The ID of the service.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://voice.api.sinch.com/v2/projects/{projectId}/services/{serviceId}'

Responses

A service object.

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",
  "updateTime": "2025-06-01T09:15:00Z",
  "name": "My Voice Service",
  "description": "Service with webhook call behavior",
  "isDefault": true,
  "callBehavior": {
    "type": "WEBHOOK",
    "webhook": { … }
  }
}

We'd love to hear from you!