Add Contact
Each user API request in TeleCMI platform includes user login token. After getting the user login token, make a POST request to the below base URL to add one or more contacts to the organization.
Base URL
Send your POST method request with valid parameters, to the following base URL.
https://rest.telecmi.com/v3/contact/add
Required Parameters
These are the required POST method parameters with description
| Parameter Name | Type | Description |
|---|---|---|
| *token | string | Your user token |
| *contacts | array | List of contact objects (max 100) |
Contact Object Fields
| Field | Type | Required | Description |
|---|---|---|---|
| *phone_no | string | Yes | Contact's phone number |
| *first_name | string | Yes | Contact's first name |
| *last_name | string | Yes | Contact's last name |
| email_id | string | No | Contact's email address |
| company | string | No | Company name |
| job_title | string | No | Job title |
Note
The * marked parameter/field is mandatory.
Sample JSON Request
Below is the following sample JSON POST method request
{
"token": "xxxx-xxxx-xxxx-xxxx",
"contacts": [
{
"phone_no": "919200000000",
"first_name": "John",
"last_name": "Doe",
"email_id": "john.doe@example.com",
"company": "Acme Corp",
"job_title": "Software Engineer"
}
]
}
Sample Response
If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below
{
"code": 200,
"msg": "Contact added successfully"
}
Properties
These are the list of properties and its description
| Property | Type | Description |
|---|---|---|
| code | number | HTTP status code (200 for success) |
| msg | string | Response message details |
HTTP status codes
TeleCMI API platform represents the following status code to identity the errors.
| Status code | Status Type | Description |
|---|---|---|
| 200 | Success | Contact added successfully |
| 400 | Error | Invalid request parameters / Validation error |
| 404 | Error | Authenticated user record not found |
| 409 | Error | Duplicate contact detected within the organization |
| 500 | Error | Something went wrong! |