Alice API

Tích hợp và sử dụng từ ứng dụng thứ 3
Mục đích:
Cho phép sử dụng Alice từ ứng dụng thứ 3. Yêu cầu bắc buộc đã đăng ký và trial alice từ onboarding antbuddy.
Cho phép chạy chiến dịch từ ứng dụng thứ 3.
Tạo alarm cho 1 liên hệ (appointment)
API chi tiết
Tất cả API request tới hệ thống Alice:
Thông qua tên miền 
1
https://alice.antbuddy.com/rest-api
Copied!
 authorize header bắt buộc:
1
Authorization: Bearer {access_token}
Copied!
Get AccessToken
1
Endpoint: /get-token/
2
Method: POST
3
Body: {
4
	"username": "username",
5
	"password": "password"
6
}
7
​
8
Description:
9
 Username: tên hoặc email đã tạo bên antbuddy
10
Password: mật khẩu
Copied!
Chiến dịch
Cấu hình callflow cho chiến dịch
Mẫu khảo sát (endpoint: /rest-api/survey-template/)
1
Create-template:
2
Method: POST
3
Params: {
4
"name": String (Tên mẫu khảo sát),
5
 "tts_language":  "vi",
6
}
Copied!
Section template (endpoint: /rest-api/section-template/)
1
Create section:
2
Method: POST
3
Body: {
4
    "type": 1,
5
    "survey": ID of survey,
6
    "question": String (tên section),
7
    "script": Text (nội dụng ivr)
8
}
9
​
10
Update section: 
11
Endpoint: /rest-api//section-template/{id}/
12
Method: PUT
13
Body {
14
	  "script" : "Vui lòng đợi trong giây lát."
15
}
16
​
Copied!
Phonebook & contact
Phonebook (endpoint: /rest-api/phonebook/)
1
Create: /rest-api/phonebook/
2
Method: POST
3
Body: {
4
    "name": String (required),
5
    "description": "rest phonebook" (option)
6
}
7
Update: /rest-api/phonebook/{id}/
8
Method: PUT
9
Body: {
10
    "Name": “changed name”,
11
    "description": “updated descrption" 
12
}
13
​
Copied!
Contact (endpoint: /rest-api/contact/)
Create single contact
1
Create:  /rest-api/contact/
2
Method: POST
3
Body: {
4
    "phonebook": {phonebook_id} (required),
5
    "contact": "0934890883" (required),
6
    "email": "[email protected]" (option),
7
    "last_name": "Huynh" (option),
8
    "first_name": "Linh" (option),
9
    "description": "khách hàng ABC" (option),
10
    "status": 1 or 0 (1: active, 0: inactivate) (required)
11
}
12
​
13
Update: /rest-api/contact/{id}/
14
Method: PUT
15
Body: {
16
    "contact": "0934890884",
17
    "status": 1,
18
    "country": "VN",
19
    "first_name": "A",
20
    "last_name": "B"
21
}
22
​
Copied!
Create multiple contact (endpoint: /rest-api/bulkcontact/)
1
EndPoint: /rest-api/bulkcontact/
2
Method: POST
3
Body: {
4
  "phonebook": 293,
5
  "contacts": [
6
    {
7
      "contact": "0934890883",
8
      "email": "[email protected]",
9
      "last_name": "Huynh",
10
      "first_name": "Linh",
11
      "status": 1
12
    },
13
    {
14
      "contact": "0934890881",
15
      "email": "[email protected]",
16
      "last_name": "Huynh",
17
      "first_name": "Linh",
18
      "status": 1
19
    }
20
  ]
21
}
Copied!
Chiến dịch thoại (Endpoint: /rest-api/campaigns/)
1
Gateway List (Endpoint: /rest-api/gateway/)
2
Method: GET
3
Response: {
4
  "results": [
5
    {
6
      "id": 23,
7
      "name": "AliceDevGateway",
8
      "status": 1,
9
      "description": "AliceDevGateway",
10
      "addprefix": "",
11
      "removeprefix": "",
12
      "gateways": "sofia/gateway/AliceDevGateway/",
13
      "subdomain": "company",
14
      "gateway_codecs": "",
15
      "gateway_timeouts": "10",
16
      "gateway_retries": "",
17
      "originate_dial_string": "",
18
      "secondused": null,
19
      "created_date": "2019-12-26T04:17:12.673711Z",
20
      "updated_date": "2020-01-14T03:12:27.079710Z",
21
      "addparameter": "",
22
      "count_call": 0,
23
      "count_in_use": null,
24
      "maximum_call": null,
25
      "is_trial": true,
26
      "failover": null
27
    }
28
  ]
29
}
Copied!
Tạo chiến dịch
1
Endpoint: /rest-api/campaigns/
2
Method: POST
3
Body Example: 
4
{
5
  "name": "rest-api-cp-2"
6
  "description": "rest api for campaign",
7
  "callerid": "lh",
8
  "phonebook": [
9
    293
10
  ],
11
  "aleg_gateway": 23,
12
  "object_id": 351,
13
  "frequency": 10,
14
  "startingdate": "2020-02-11T02:36:39.045000Z",
15
  "expirationdate": "2020-02-12T02:36:39.045000Z",
16
  "daily_start_time": "08:00:00",
17
  "daily_stop_time": "21:00:00"
18
}
19
​
20
Description:
21
- name: required,
22
- description: rest api for campaign (option),
23
- callerid: caller name when callout (option),
24
- phonebook: phone book IDs list (required),
25
- aleg_gateway:gateway dialout (required),
26
- object_id: survey template application (required),
27
- frequency: call per minute (required),
28
- startingdate: Starting date campaign (required),
29
- expirationdate: Stopped date campaign (required),
30
- daily_start_time: dialy time (required),
31
- daily_stop_time: dialy ending time(required)
Copied!
Cập nhật chiến dịch thoại
1
Endpoint: /rest-api/campaigns/{id}/
2
Method: PUT
3
Body:
4
{
5
  "name": "rest-api-cp-2",
6
  "description": "rest api for campaign",
7
  "callerid": "rest_api",
8
  "phonebook": [
9
    293
10
  ],
11
  "frequency": 3,
12
  "startingdate": "2020-02-11T02:36:39.045000Z",
13
  "expirationdate": "2020-02-12T02:36:39.045000Z",
14
  "daily_start_time": "09:00:00",
15
  "daily_stop_time": "18:00:00"
16
}
Copied!
Start chiến dịch thoại
1
Endpoint: /rest-api/campaigns/{id}/status/
2
Method: POST
3
Body: {
4
  "status": 1,
5
}
6
​
7
Description:
8
START = 1
9
PAUSE = 2
10
ABORT = 3
11
END = 4
Copied!
Appointment
Survey list (Endpoint: /rest-api/survey-list/)
1
Endpoint: /rest-api/survey-list/
2
Method: GET
3
Response:
4
{
5
  "results": [
6
    {
7
      "id": 953,
8
      "campaign": {
9
        "id": 1008,
10
        "name": "rest-api-cp-2",
11
        "status": 4
12
      },
13
      "name_full": "linhhv-sv-api : rest-api-cp-2",
14
      "name": "linhhv-sv-api",
15
      "tts_language": "vi",
16
      "description": null,
17
      "is_onboarding": false,
18
      "created_date": "2020-02-11T02:32:34.971249Z",
19
      "updated_date": "2020-02-11T02:32:34.971283Z",
20
      "user": 1
21
    }
22
  ]
23
}
24
​
Copied!
Thiết lập lịch
1
Endpoint: /rest-api/calendar-setting/
2
Method: POST
3
Body: {
4
  "label": "rest-api-cp-2",
5
  "callerid": "mantest_calendarsettings",
6
  "caller_name": "",
7
  "call_timeout": 60,
8
  "survey": 953,
9
  "aleg_gateway": 23
10
}
11
​
12
Description:
13
- label: tên  (required),
14
- callerid: caller hiển thị (option),
15
- caller_name: tên người gọi (option),
16
- call_timeout: thời gian cuộc gọi timeout  bằng giây (required),
17
- survey": id của khảo sát (required), get from Survey List API
18
- aleg_gateway: cổng nối gọi ra (required),
19
  Get from Gateway List API
20
​
Copied!
Calendar User
1
Endpoint: /rest-api/calendar-user/
2
Method: POST
3
Body:
4
{
5
  "username": "cal-rest-user-resp2",
6
  "password": "12345678" - required,
7
  "calendar_setting": 4 - required
8
}
9
​
10
Description:
11
- username: user login (required)
12
- calendar_setting: Calendar setting,
13
 GET from calendar-setting API
Copied!
Tạo lịch
1
Endpoint: /rest-api/calendar/
2
Method: POST
3
Body: {
4
  "name": "linh-calendar-rest",
5
  "user": 5 - required
6
}
7
​
8
Description: 
9
- name: required  
10
- user: Calendar User List, 
11
Get from calendar-user API
Copied!
Tạo sự kiện
1
Endpoint: /rest-api/event/
2
Method: POST
3
Body: {
4
  "title": "today-linhhv",
5
  "description": "",
6
  "start": "2020-02-15T09:30:39.177000Z",
7
  "end": "2020-02-15T10:13:39.177000Z",
8
  "creator": 115,
9
  "calendar": 7
10
}
11
​
12
Description:
13
- title: Tên sự kiện (required)
14
- start: Thời gian bắt đầu (required)
15
- end: Thời gian kết thúc (required)
16
- creator: calendar user được gắn vào, 
17
  được lấy từ calendar-user API
18
- calendar: Lịch gắn vô sự kiện, 
19
được lấy từ calendar API
Copied!
Tạo Alarm
1
Endpoint: /rest-api/alarm/
2
Method: POST
3
Body: 
4
{
5
  "alarm_phonenumber": "0934890883",
6
  "date_start_notice": "2020-02-12T02:49:33.572Z",
7
  "phonenumber_transfer": "",
8
  "event": 8
9
}
10
​
11
Description: 
12
- alarm_phonenumber: call to number (required),
13
- date_start_notice: starting date alarm - (option- default current time),
14
- phonenumber_transfer: phone to transfer (option),
15
- event: related event (required), event list get from event API, method Get
16
​
Copied!
KẾT NỐI - Previous
Mã lỗi
Next - Alice Voice Blaster
Voice OTP
Last modified 1yr ago
Copy link
Contents
Tích hợp và sử dụng từ ứng dụng thứ 3