TrueCLID call start allows you to populate our database with an outbound phone call that you are PLACING. See the What does TrueCLID do article for details. Below are the request fields you will send:
| Field | Required | Value | Comment |
| username | Yes | API Key Username | Not the web login username. Used to authenticate your account. |
| password | Yes | API Key Password | Not the web login password. Used to authenticate your account. |
| resp_type | No | If passed: "simple", "basic", "extended" |
Optional, allows specifying response type on per-query basis. If not passed, will use account default. |
| resp_format | No | If passed: "csv", "json", "xml" | Optional, allows specifying response format on per-query basis. If not passed, will use account default. See this. |
| calling_number | Yes | E.164 number that you are calling from |
This is the number that you are calling from. E.164 format (including Country Code). See NOTE 1 below. |
| called_number | Yes | E.164 number that is being called |
This is the number that is being called by you. E.164 format (including Country Code). |
| call_party | Yes | "orig_call_start" |
This specifies that you are populating to TrueCLID an outbound call you are placing. |
NOTE 1: if your application/software does not know the calling number, you should not use TrueCLID and it will not be beneficial to you. Do not send or static or incorrect information in this field.
Here is an example request using both the mandatory and optional fields, where you are telling TrueCLID that you are placing a call TO: 16465557000 and are calling FROM: 12125551212:
https://api.truecnam.net/api/v1?username=APIkey&password=APIpassword&resp_format=json&resp_type=extended&calling_number=12125551212&called_number=16465557000&call_party=orig_call_start
Response Fields:
The fields within the table below are organized in the same order as a response in CSV format will be returned (other formats will include the field name in response). Depending on the resp_type you choose ("simple", "basic", "extended") certain fields will be returned as shown below:
| Field | simple | basic | extended | Type | Note |
| status | Yes | Yes | Yes | String | "ok" or "error" |
| err | No | Yes | Yes | String | Error number |
| error_msg | No | Yes | Yes | String | Error description text |
Here's an example of a response in extended json format:
{"status": "ok", "error_msg": "", "err": "0"}
Next,
Are you a carrier/service provider? See how to use TrueCLID call end.
Or, if you're an end user, see the Response formats.