Here's the translation of the article to English, keeping the specified exceptions unchanged:
API Ringostat. Передача інформації у Ringostat Smart Phone та книгу контактів
Transmitting information about contact/lead/deal in Ringostat Smart Phone and contact book This method will allow transmitting information from CRMs that integrate via Webhook, to display customer information in the Ringostat Smart Phone contact book and call log.
Using this method, you can send:
Name
Phone number
Email
Quick link to contact or deal
Main request parameters:
API request address: https://api.ringostat.net/minicrm/contacts/sync
Method — POST;
Request Headers:
Content-Type - application/json auth-key - this is the electronic key to access your project in Ringostat x-project-id - ID of your project
Request Body:
Name of the Parameter | Data Type | Mandatory | Description |
projectId | int | Yes |
|
fullName | string | Yes |
|
origin | string | Yes |
|
externalId | string | Yes. Maybe = null if the lead_id field is filled |
|
leadId | string | Yes. Maybe = null if the external_id field is filled |
|
responsible | string | Yes |
|
staffId | string | Yes. Maybe = null |
|
contactLink | string | Yes. Maybe = null |
|
leadLink | string | Yes. Maybe = null |
|
dealLink | string | Yes. Maybe = null |
|
googleClientId | string | Yes. Maybe = null |
|
contactDirections | array of objects | Yes |
|
type | string | Yes |
|
name | string | Yes |
|
value | string | Yes |
|
organizations | array of objects | Yes. Maybe = null |
|
projectId | int | Yes, if "organizations" is filled |
|
name | string | Yes, if "organizations" is filled |
|
externalid | string | Yes, if "organizations" is filled |
|
origin | string | Yes, if "organizations" is filled |
|
Request example:
curl -i -X POST \
-H "auth-key:unique_auth_key_value" \
-H "x-project-id:project-id" \
-H "Content-Type:application/json" \
-d \
'{
"contacts": [
{
"projectId": project-id,
"fullName": "Client name",
"origin": "Crm name",
"externalId": null,
"leadId": "7895643",
"responsible": "manager1",
"staffId": null,
"contactLink": "https://crmname.com/contact/6835653",
"leadLink": "https://crmname.com/lead/7895643",
"dealLink": "https://crmname.com/deal/1835367",
"googleClientId": null,
"organizations": [
{
"projectId": project-id,
"name": "Organization name",
"externalId":"124532",
"origin": "Crms name"
}
],
"contactDirections": [
{
"name": "Client name",
"type": "phone",
"value": "+380111111111"
},
{
"name": "Client name",
"type": "email",
"value": "с[email protected]"
}
]
}
]
}' \
'https://api.ringostat.net/minicrm/contacts/sync'
Transmitting organization information to Ringostat Smart Phone This method transmits organization information to supplement the contact in the Ringostat Smart Phone contact book.
Main request parameters:
API request address: https://api.ringostat.net/minicrm/organizations/sync
Method — POST;
Request Headers:
Content-Type - application/json
auth-key - this is the electronic key to access your project in Ringostat
x-project-id - ID of your project
Request Body:
Request example:
curl -i -X POST \
-H "auth-key:unique_auth_key_value" \
-H "x-project-id:project-id" \
-H "Content-Type:application/json" \
-d \
'{
"organizations": [
{
"projectId": 106,
"name": "organization1",
"externalId": "1",
"origin": "Crm"
},
{
"projectId": 106,
"name": "organization2",
"externalId": "2",
"origin": "Crm"
},
{
"projectId": 106,
"name": "organization3",
"externalId": "3",
"origin": "Crm"
}
]
}' \
'https://api.ringostat.net/minicrm/organizations/sync'
You can also view the description and examples in your personal account, in the
"Settings" - "Integrations" - "Ringostat API" section, by clicking on the desired API method:
[Image placeholder]
Example display in RSP and call log
The deal, lead, and contact buttons will be active, with links you specified during the API request
The contact will also be available in the RSP contact list
Example of client display in the call log:
Important! We will display client data in the call log only for new calls that were made after the request.