Retrieve all Contact List for new Message

New Message Contact List

Base URL

https://apimobile.callproof.com

Endpoint

/api/new-message-contact-list

Purpose

Returns a paginated list of contacts that can be selected when composing a new message. Results are limited to contacts that have a phone number and are matched against the provided search text across company name, person name, and phone number, so the user can quickly find the right recipient.

HTTP Method

POST

Headers

Header	Required	Description
Authorization	Yes	Bearer access token

Security

• Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number for paginated results

Request Body

Parameter	Type	Required	Description
search_fields	string	Yes	Search text used to find contacts by company name, person first name, last name, full name, or phone number
only_my_assigned_contact	string	No	When set to 1, returns only contacts assigned to the authenticated user. Defaults to 0

Successful Response (200)

Indicates that matching message-ready contacts were retrieved successfully. The response includes recipient-oriented contact records for the current page plus pagination metadata.

Field	Type	Description
clientStatusCode	integer	Status indicator for the client (for example, 200)
user_id	integer	Identifier of the authenticated user
company_id	integer	Identifier of the authenticated user’s company
data	array	List of contacts for the current page
data[].contact_id	integer	Unique contact identifier
data[].company_name	string	Company / account name
data[].phone	string	Phone number available for messaging
data[].person_name	string	Associated person name
data[].contact_personnel_id	integer	Identifier of the associated contact person
data[].contact_phone_id	integer	Identifier of the phone record used for messaging
firstItemOnPage	integer	Index of the first item on the current page
hasNextPage	boolean	Whether another page of results is available
next_page_url	string	URL for the next page, when available
prev_page_url	string	URL for the previous page, when available
first_page_url	string	URL for the first page
last_page_url	string	URL for the last page
hasPreviousPage	boolean	Whether a previous page exists
isFirstPage	boolean	Whether the current page is the first page
isLastPage	boolean	Whether the current page is the last page
lastItemOnPage	integer	Index of the last item on the current page
pageCount	integer	Total number of pages
pageNumber	integer	Current page number
pageSize	integer	Number of items per page
totalItemCount	integer	Total number of matching contacts
uri	string	Requested resource URI

Error Responses

Status Code	Meaning
400	Bad Request – the new message contact list could not be retrieved successfully
401	Unauthorized / validation failure – missing required search_fields, or missing/invalid/expired Bearer token

• 400 – The service encountered an error while retrieving contacts for new messaging.
• 401 – Required search text was not provided, or authentication failed / the access token is missing or expired.