---
title: "Send a voice code"
method: POST
path: "/voices"
tags: ["Voices"]
---

# Send a voice code

`POST /voices`

Sends an outbound voice call verification code.

## Request body

- VoiceSendRequest
  - `to` string, required — The recipient's phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
  - `verificationCode` string, required — The verification code to be sent, 4 to 6 digits.
  - `language` string — [ISO 639 Language Code](https://www.iso.org/iso-639-language-codes.html). If not specified, language will be set as `en` by default. Notably, in certain countries or regions, language will be automatically set as the local language due to the regional restrictions. Applicable languages: `ar`: Arabic `de`: German `en`: English `es`: Spanish `fr`: French `id`: Indonesian `it`: Italian `pt`: Portuguese `ru`: Russian `tr`: Turkish `vi`: Vietnamese `zh`: Chinese
  - `externalId` string — A unique (recommended) string to reference the object. This can be an order number or similar, and can be used to reconcile the object with your internal systems.
  - `callbackUrl` string — Delivery report URL. You can provide a URL, and we will push the updated status report to your server in time. e.g., https://httpbin.org/anything?tag=api. Note: We recommend configuring Webhook Endpoints instead.

## Response `200`

The request is successfully accepted.

- Voice
  - `id` string, required — Unique ID for the object.
  - `to` string, required — The recipient's phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
  - `verificationCode` string — The verification code to be sent, 4 to 6 digits.
  - `language` string — [ISO 639 Language Code](https://www.iso.org/iso-639-language-codes.html).
  - `regionCode` string — [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
  - `totalSegments` integer — Number of message segments. It's always 1 for voice calls.
  - `totalPrice` number, double — Total price of this message.
  - `currency` string — Price currency. [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217).
  - `status` 'accepted' | 'failed' | 'sent' | 'delivered' | 'undelivered' — Delivery status. One of `accepted`, `sent`, `delivered`, `undelivered`, or `failed`. - `accepted`: The messaging request is accepted by our system. - `failed`: The message failed to be sent from our system. - `sent`: The message has been sent from our system. - `delivered`: Our system has received a delivery receipt indicating that message is delivered. - `undelivered`: Our system has received a delivery receipt indicating that message is not delivered.
  - `errorCode` string — Error code when the message is undeliverable.
  - `createTime` string, date-time — The time at which this message was created, formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). e.g., `2022-03-01T12:00:00.000Z`.
  - `updateTime` string, date-time — The time at which the delivery report for this message was updated, formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). e.g., `2022-03-01T12:00:00.000Z`.
  - `externalId` string — A unique (recommended) string to reference the object. This can be an order number or similar, and can be used to reconcile the object with your internal systems.
  - `callbackUrl` string — Delivery report URL. You can provide a URL, and we will push the updated status report to your server in time. e.g., https://httpbin.org/anything?tag=api. Note: We recommend configuring Webhook Endpoints instead.
  - `bizType` string — This can be either empty or one of `voice`, or `verify`. Defaults to `voice`. - `voice`: Indicates that the message is sent via the **Voice** product. - `verify`: Indicates that the message is sent via **Verify** product.
  - `verificationId` string — The verification ID. Included only when `bizType` is `verify`.

---

[API](https://skmtc.dev/ycloud/apis/ycloud-api.md) · [All operations](https://skmtc.dev/ycloud/apis/ycloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ycloud/ycloud-api/revisions/4e13d3ca9df8/schema)