Wiki » English version » Theory of operation » API » REST API »
HTTP API amocrm settings¶
Saves settings for integration with AmoCRM for this account.
Mandatory arguments¶
| argument |
description |
| _login |
coincides with the user/company login to the personal account |
| _password |
matches the user/company password to the personal account |
Optional arguments¶
| widget |
name of the widget inside the AmoCRM |
| domain |
domain personal account AmoCRM |
| login |
login to your AmoCRM account |
| api_key |
API key to your AmoCRM account |
| enabled |
1 - if the widget is on, 0 - if the widget is off |
| phones |
matching user ID and extension number inside AmoCRM |
| redirect_to_responsible_user |
1 - enabled, 0 - disabled |
| set_caller_name_from_contact |
1 - enabled, 0 - disabled |
| create_contact_on_incoming_call |
1 - enabled, 0 - disabled |
| create_contact_on_outgoing_call |
1 - enabled, 0 - disabled |
| create_task_on_contact_creation |
1 - enabled, 0 - disabled |
| create_task_on_missed_call |
1 - enabled, 0 - disabled |
| language |
personal account language: ru - russian, en - english |
| phone_field_id |
'phone' field ID - Smartswitch should know to add a new phone to AmoCRM accounts |
Returned data¶
| status |
"ok", if the operation completed without an error,
"error", if an error occurred, or if it was not possible to return useful data |
| data |
useful data, returned when status = "ok" |
| errors |
error details, returned when status = "error" |
Example¶
| request |
POST https://your.server.name/api/amocrm_settings?_login=LOGIN&_password=PASSWORD |
| request body |
widget="amo_smartswitch"
domain="new59c134f76431f.amocrm.ru"
login="mytestaccount@gmail.com"
api_key="e91a827a019863febe7349e35f365af5"
enabled=1
phones[1741108]="100"
phones[1741491]="101"
phones[1749058]="102"
redirect_to_responsible_user=1
set_caller_name_from_contact=1
create_contact_on_incoming_call=1
create_contact_on_outgoing_call=1
create_task_on_contact_creation=1
create_task_on_missed_call=1
language="ru"
phone_field_id=228085 |
| response |
{
"data": null,
"status": "ok"
} |
Русский перевод
Also available in: PDF
HTML
TXT