--- title: "Create a call" url: "https://docs.unified.to/uc/call/Create_a_call" description: "Create a call with Unified's Call API (POST /uc/{connection_id}/call). Filter by fields and raw. Supported by 7 Call integrations." date: "2026-10-23T08:49:52.617Z" updated: "2026-10-23T08:49:52.617Z" --- # Create a call Updated: October 23, 2026 POST/uc/{connection\_id}/call Creates a UcCall. Provide the unified UcCall fields in the request body; they are mapped to the provider's API. Returns the created UcCall. ## Parameters **fields**string array id created\_at updated\_at contact\_id telephone start\_at end\_at user\_id contacts is\_private user\_name user\_phone type metadata raw conversation\_identifier status answer\_at duration\_seconds cost\_amount currency parent\_id instructions Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection ## Payload **id**string Unique identifier for this call object **created\_at**date-time The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date-time The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **contact\_id**string The contact ID for call (reference to UcContact) **telephone**object The telephone number called **start\_at**date-time The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **end\_at**date-time The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **user\_id**string (reference to HrisEmployee) **contacts** array **is\_private**boolean **user\_name**string **user\_phone**string **type** enum Valid values: "INBOUND" "OUTBOUND" **metadata** array **raw** The raw data returned by the integration for this call **conversation\_identifier**string opaque identifier shared across legs of one interaction **status** enum Valid values: "QUEUED" "RINGING" "IN\_PROGRESS" "COMPLETED" "BUSY" "NO\_ANSWER" "FAILED" "CANCELED" "OTHER" The current or final status of the call **answer\_at**date-time When the call was answered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **duration\_seconds**number Call length in seconds **cost\_amount**number What the integration charged for the call **currency**string ISO 4217 currency of cost\_amount **parent\_id**string The parent call (leg) that this call belongs to **instructions** array Write-only: what the call does once answered (create/update only; never returned) ## Returns [UcCall](https://docs.unified.to/uc/call/model.md) | Response field | Type | Required | Description | | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | id | string | No | Unique identifier for this call object | | created\_at | string (date-time) | No | The date that this call object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | The last date that this call object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | contact\_id | string | No | The contact ID for call (reference to UcContact) | | telephone | object | No | The telephone number called | | telephone.telephone | string | No | | | telephone.type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | start\_at | string (date-time) | No | The start time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | end\_at | string (date-time) | No | The end time of the call (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | user\_id | string | No | (reference to HrisEmployee) | | contacts | [UcContact](https://docs.unified.to/uc/call/Create%5Fa%5Fcall.md#UcContact)\[\] | No | | | contacts\[\].id | string | No | Unique identifier for this contact object | | contacts\[\].created\_at | string (date-time) | No | The date that this contact object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | contacts\[\].updated\_at | string (date-time) | No | The last date that this contact object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | contacts\[\].name | string | No | The name of the contact | | contacts\[\].first\_name | string | No | | | contacts\[\].last\_name | string | No | | | contacts\[\].title | string | No | The job title of the contact | | contacts\[\].company | string | No | The company/organization name of the contact | | contacts\[\].emails | [UcEmail](https://docs.unified.to/uc/call/Create%5Fa%5Fcall.md#UcEmail)\[\] | No | An array of email addresses for this contact | | contacts\[\].emails\[\].email | string | Yes | | | contacts\[\].emails\[\].type | enum | No | Values: WORK, HOME, OTHER | | contacts\[\].telephones | [UcTelephone](https://docs.unified.to/uc/call/Create%5Fa%5Fcall.md#UcTelephone)\[\] | No | An array of telephones for this contact | | contacts\[\].telephones\[\].telephone | string | Yes | | | contacts\[\].telephones\[\].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | contacts\[\].metadata | [UcMetadata](https://docs.unified.to/uc/call/Create%5Fa%5Fcall.md#UcMetadata)\[\] | No | | | contacts\[\].metadata\[\].id | string | No | | | contacts\[\].metadata\[\].slug | string | No | | | contacts\[\].metadata\[\].value | object | No | | | contacts\[\].metadata\[\].namespace | string | No | | | contacts\[\].metadata\[\].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL | | contacts\[\].metadata\[\].extra\_data | object | No | | | is\_private | boolean | No | | | user\_name | string | No | | | user\_phone | string | No | | | type | enum | No | Values: INBOUND, OUTBOUND | | metadata | [UcMetadata](https://docs.unified.to/uc/call/Create%5Fa%5Fcall.md#UcMetadata)\[\] | No | | | metadata\[\].id | string | No | | | metadata\[\].slug | string | No | | | metadata\[\].value | object | No | | | metadata\[\].namespace | string | No | | | metadata\[\].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL | | metadata\[\].extra\_data | object | No | | | conversation\_identifier | string | No | opaque identifier shared across legs of one interaction | | status | enum | No | The current or final status of the call Values: QUEUED, RINGING, IN\_PROGRESS, COMPLETED, BUSY, NO\_ANSWER, FAILED, CANCELED, OTHER | | answer\_at | string (date-time) | No | When the call was answered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | duration\_seconds | number | No | Call length in seconds | | cost\_amount | number | No | What the integration charged for the call | | currency | string | No | ISO 4217 currency of cost\_amount | | parent\_id | string | No | The parent call (leg) that this call belongs to | | instructions | [UcCallInstruction](https://docs.unified.to/uc/call/Create%5Fa%5Fcall.md#UcCallInstruction)\[\] | No | Write-only: what the call does once answered (create/update only; never returned) | | instructions\[\].type | enum | Yes | Values: SAY, PLAY, PAUSE, DIAL, HANGUP | | instructions\[\].text | string | No | SAY: text to speak | | instructions\[\].language | string | No | SAY: BCP 47 language code (e.g. en-US), passed through as-is (Bandwidth maps it to its nearest locale) | | instructions\[\].audio\_url | string | No | PLAY: public MP3 or WAV URL | | instructions\[\].seconds | number | No | PAUSE: length of silence | | instructions\[\].telephone | [UcCallInstruction\_telephone](https://docs.unified.to/uc/call/Create%5Fa%5Fcall.md#UcCallInstruction%5Ftelephone) | No | DIAL: number to dial and bridge | | instructions\[\].telephone.telephone | string | Yes | | | instructions\[\].telephone.type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | instructions\[\].sip\_uri | string | No | DIAL: SIP address to dial instead of telephone | | instructions\[\].user\_phone | string | No | DIAL: caller ID on the dialed leg (defaults to the call's user\_phone) | | instructions\[\].timeout\_seconds | number | No | DIAL: how long to ring before giving up | ## Errors Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Too many requests to unified.to API; max requests per minute: N" } ``` | Status | Error | Meaning | | ------ | --------------------- | ------------------------------------------------- | | 400 | Bad Request | The request was malformed or failed validation. | | 401 | Unauthorized | The connection is likely broken; re-authorize it. | | 403 | Forbidden | The connection is missing permissions or scopes. | | 404 | Not Found | The requested resource does not exist. | | 429 | Too Many Requests | Rate limit exceeded (see the two sources below). | | 500 | Internal Server Error | An unexpected error occurred. | | 501 | Not Implemented | Not supported by this integration. | Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. ### 429 Too Many Requests A 429 has two possible sources: * The integration's own rate limit, passed through. * Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const results = await sdk.uc.createUcCall({ connectionId, ucCall: { }, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'POST', url: 'https://api.unified.to/uc/5de520f96e439b002043d8dc/call', headers: { authorization: 'bearer .....' }, data: undefined, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("POST", "https://api.unified.to/uc/5de520f96e439b002043d8dc/call?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/uc/5de520f96e439b002043d8dc/call?fields=&raw= req, _ := http.NewRequest("POST", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/uc/5de520f96e439b002043d8dc/call?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.post(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/uc/5de520f96e439b002043d8dc/call?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/uc/5de520f96e439b002043d8dc/call?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request POST \ --url 'https://api.unified.to/uc/5de520f96e439b002043d8dc/call?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```