API version 2

Requests to the API are via HTTP protocol.

All requests have the form: https://salesscriptprompter.com/integration/apiv2/controller/method?key=API-KEY

• https://salesscriptprompter.com/integration/apiv2 — this part of URL is permanent
• controller/method — routing for data acquisition. Options will be described below.
• key — the API key (so you can send as HTTP header - Key:Your API key)
  
  

API key verification(user/check)

Verification of the correct API key entered by the user.

URL request:

Response example:

{
  "key": 'key',
  "user_id": 0
}

User list (user/list)

Lists your users with their roles and authorization keys.

URL request:

Response example:

[
    {"id":123456,"role":"user_head_manager","login":"[email protected]","auth_token":"key 1"},
    {"id":123457,"role":"user_designer","login":"[email protected]","auth_token":"key 2"},
    {"id":123459,"role":"user_supervisor","login":"[email protected]","auth_token":"key 4"},
    {"id":123458,"role":"user_operator","login":"[email protected]","auth_token":"key 3"}
]

User authorization (user/auth)

Authorizes the user by ID and authorization token.

URL request:

Parameters:

• id [required] — user ID
• token [required] — User authorization token

Response:

Redirects to the main page.

List of scripts (script/list)

Returns a list of user scripts. Every list item contains the script ID, title, and label – whether the script is published or not. By default, returns all published scripts.

URL request:

Response example:

[
  {
    "id": 1617,
    "name": "Prohod Sekretaria",
    "published": 0
  },
  {
    "id": 460,
    "name": "The purpose of the meeting",
    "published": 1
  },
  {
    "id": 198,
    "name": "Smart4smart 3.0",
    "published": 1
  }
]

Add call record (call/attach-record)

Attaches to call the URL of the record of the phone conversation. The URL must be accessible and lead to the audio file, so you can listen using the online player.

URL request:

Parameters:

• id [required] — call ID. You can get the call ID using WebHooks
• url [required] — conversation record URL (urlencoded string)

List of custom fields (field/list)

Returns a list of fields that can be used when running scripts.

URL request:

Response example:

[
    {"id":1,"code":"name","account_id":1,"name":"Имя","type":"string","type_data":""},
    {"id":2,"code":"gender","account_id":1,"name":"Пол","type":"in","type_data":"М, Ж"}
]

Create a custom field (field/create)

Creates a custom field

Parameters:

• code [required] — field code used to identify the field when running scripts
• name [required] — the name of the field
• type [required] — field type (possible values: string, number, date, boolean, in)
• type_data [optional] — choice options (to be filled in for field type `in`)

URL request:

Response example:

{result: true}

{result: false, errors: []}

Change custom field (field/update)

Changes the custom field

Parameters:

• code [required] — field code used to identify the field when running scripts
• name [optional] — field name
• type [optional] — field type (possible values: string, number, date, boolean, in)
• type_data [optional] — choice options (to be filled in for field type `in`)

URL request:

Response example:

{result: true}

{result: false, errors: []}

Delete custom field (field/delete)

Delete the custom field

Parameters:

• code [required] — field code used to identify the field when running scripts

URL request:

Response example:

{result: true}