OmiCall API
  • Overview
  • OMICALL API
    • Tổng quan
    • Xác thực
    • Doanh nghiệp
    • Nhân viên
    • Khách hàng
      • v1
      • v2
    • Tổng đài
    • Lịch sử cuộc gọi
      • v1
      • v2
    • Gọi tự động
      • Gọi tự động sử dụng callBot
      • Gọi tự động thông thường - API V2
    • Webhooks
    • Click To Call
    • Ticket
      • v2
    • API tiêu chí kịch bản
    • Đa kênh
    • AI API
      • Text To Speech API
      • Speech To Text API
      • Gọi tự động sử dụng callBot
      • Phân tích cuộc gọi
  • WEBHOOKS
    • Tổng quan
    • Webhook
  • SDK Tích Hợp
    • Web Extension
      • Changelog
      • Pancake
      • Sapo
      • Haravan
      • Nhanh.vn
      • TPos.vn
      • KiotViet
      • Bitrix24
    • Web SDK
      • v3 Integration
      • v3 Changelog
      • v2 Integration
      • v2 Changelog
    • MOBILE SDK
      • Tổng Quan
      • Tại sao lại sử dụng OMICALL
      • Định nghĩa đầu số
      • Các SDK Hỗ Trợ
      • Tài khoản đăng nhập
      • IOS SDK
        • Cấu hình Push Notification
        • Cài đặt
        • Khởi tạo SDK
        • Xử lý các sự kiện
      • Android SDK
        • Cấu hình SDK
        • Cấu hình Push Notification
        • Khởi tạo SDK
        • Lắng nghe các sự kiện
      • Flutter SDK
      • React-Native SDK
    • Deep Links App to App
  • PARTNER
    • Tổng quan
    • Kho đầu số
    • Gói dịch vụ
    • Lịch sử thanh toán
    • Quản lý doanh nghiệp
    • Thông tin đối tác
Powered by GitBook
On this page

Was this helpful?

  1. WEBHOOKS

Webhook

Webhook cuộc gọi

PreviousTổng quanNextWeb Extension

Last updated 6 months ago

Was this helpful?

Nhận dữ liệu cuộc gọi từ Webhook

  • Đối tác khai báo API để nhận dữ liệu cuộc gọi từ WEBHOOK trả về

  • METHOD : POST

  • Content-type : application/json

Webhook data khi cuộc gọi đã kết thúc

Truy cậu cấu hình tại :


{
  "answer_sec": 5, // Số giây trả lời 
  "bill_sec": 6, // Thời lượng cuộc gọi , tính tiền 
  "call_out_price": 55.002, // Tổng tiền cuộc gọi 
  "call_uuid": "787e1711-06af-4054-9d31-4a34a638292c", // ID của cuộc gọi 
  "create_by": { // Người tạo hoặc nhân viên thực hiện cuộc gọi đó
    "contact_id": "6209c98c067f745da47367d1",
    "id": "6209c98561c1cb163ded25fa",
    "name": "Trần Văn Tiến 1234"
  },
  "created_date": 1697595795704, // Ngày tạo
  "customer": {
    "full_name": "Mr. Tiến Demo2",
    "full_name_unsigned": "mr. tien demo2"
  },
   "collect_info_variables": // Đây là các biến thu thập được theo kịch bản đối với callbot
   [
    {
      "collect_info_executed_time": {
        "end": 17.440811157226562,
        "start": 13.95820426940918
      },
      "entire_user_sentence": "tầm 2 giờ chiều nhá",
      "entity_type_code": "omi_entity_datetime",
      "variable_code": "AeMd2JtJ7O",
      "variable_name": "new_ship_time",
      "variable_value": "02:00"
    }
  ],
  "destination_number": "039.....", // Số bị gọi
  "direction": "outbound", // Hướng gọi : inbound, outbound, local
  "domain_fusion": "contact18",
  "duration": 12, // Tổng thời gian, tính từ khi có tín hiệu rung chuông
  "endby_name": "end_call_by_customer",
  "from_number": "100",
  "hotline": "842899959300", // Số hotline
  "is_auto_call": false,
  "is_have_forward_out": false,
  "is_voicemail": false, // nếu cuộc này là voicemail ( chỉ có đối với cuộc gọi callbot)
  "ivr": "none",
  "last_updated_date": 1697595795853,
  "note": "",
  "phone_number": "03951.....",
  "provider": "viettel",
  "record_seconds": 5,
  "recording_file_url": "https://public-v1-stg.omicrm.com/third_party/recording/uc?id=SVJ1TTVlK0ZUZUdZZ1luR3VEdTlNemIwYTAwb3FEY2VkekJveGtvRTRhdlV2NCtKcytDT1dNbEJsOFRXWWhqWmpKSmNmUUtRQW40V1ZpbGpWZnpzVkE9PQ==&code=ae5f56fc-7baa-4537-b312-1105023bbb49",
  "send_num_retry": 1,
  "sip_number": "842899959300",
  "sip_user": "100",
  "source_number": "842899959300",
  "state": "cdr",
  "tag": [],
  "tenant_id": "6209c98461c1cb163ded25f7",
  "time_end_call": 1697595795,
  "time_start_call": 1697595783, // Thời gian bắt đầu gọi 
  "time_start_to_answer": 1697595783,
  "to_number": "0395187319",
  "transaction_id": "ae5f56fc-7baa-4537-b312-1105023bbb49", // ID cuộc gọi
  "transfer_histories": [], // lịch sử cuộc gọi được chuyển tới những nhân viên ( extension) nào
  "user": [
    {
      "full_name": "Trần Văn Tiến 1234",
      "full_name_unsigned": "Tran Van Tien 1234"
    }
  ],
  "autocall_id": "6728787b11651529be30a7ec", //ID phiên autocall
  "autocall_uuid": "844fb9c2-6d88-4706-9a22-eaa8b759b52c" //UUID của chi tiết cuộc gọi autocall 
}

Webhook khi cuộc gọi đang diễn ra

  • Gửi thông tin cuộc gọi đang diễn ra cho đối tác tích hợp

  • Trạng thái gồm : ringing(Đổ chuông), answered (Kết nối) , hangup (Kết thúc)

{
  "to_number": "0395187319", // Số điện thoại khách hàng
  "created_time": 1626693561, // Ngày khởi tạo cuộc gọi
  "date_time": 1626693561000, // Thời gian hook
  "from_number": "100", // Số máy lẻ gọi
  "hotline": "0868694566", // Số hotline của doanh nghiệp
  "call_uuid": "fee91d6c-90b0-4826-97d7-9ca74c58a4e7", // Id cuộc gọi = transaction_id
  "state": "ringing", //ringing : Đang kết nối; answered : Kết nối, hangup : Kết thúc 
  "direction": "outbound" // outbound : Gọi ra, inbound : Gọi vào
}