Get 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 retrieve a single contact or a paginated list of contacts.

Base URL

Send your POST method request with valid parameters, to the following base URL.

https://rest.telecmi.com/v3/contact/get

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
*token	string	Your user token
contact_id	string	Retrieve a specific contact by UUID
limit	number	Items per page (default: 10, max: 100)
page_state	string	Cursor for next page

Note

The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
  "token": "xxxx-xxxx-xxxx-xxxx",
  "limit": 10
} 

Sample Response

If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below

{
  "code": 200,
  "contacts": [
    {
      "contact_id": "d3b07384-d113-4ec5-a5ae-be81d6e3c239",
      "phone_no": "919200000000",
      "first_name": "John",
      "last_name": "Doe",
      "email_id": "john.doe@example.com",
      "company": "Acme Corp",
      "job_title": "Software Engineer"
    }
  ],
  "count": 150,
  "page_state": "cursor_string_for_next_page"
}

Properties

These are the list of properties and its description

Property	Type	Description
code	number	HTTP status code (200 for success)
contacts	JSON array	List of contact objects
contact_id	string	UUID of the contact
phone_no	string	Contact's phone number
first_name	string	Contact's first name
last_name	string	Contact's last name
email_id	string	Contact's email address
company	string	Company name
job_title	string	Job title
count	number	Total number of contacts in the organization
page_state	string	Cursor for retrieving the next page of results

HTTP status codes

TeleCMI API platform represents the following status code to identity the errors.

Status code	Status Type	Description
200	Success	Request was successful
400	Error	Invalid request parameters / Validation error
404	Error	Authenticated user record not found
500	Error	Something went wrong!