搜尋聯絡人資料(Partner Limit)

概述

若需要查找特定的聯絡人資訊,此 API 提供便捷的搜尋功能。不論是 LINE、Facebook 客戶的資料,你都能透過建立時間、客戶系統編號等條件進行精確篩選。

API

curl -X GET
    -H "Content-Type: application/json"
    目前為商業夥伴限定,暫不開放。

URL Parameters

Parameter
require
Description

contactable_type

管道類型包括以下選項:

  • 即時聊天App\LivechatContact

  • LINE OAApp\LineContact

  • Facebook MessengerApp\FbContact

  • InstagramApp\IgContact

  • TelegramApp\TelegramContact

  • ViberApp\ViberContact

  • 微信App\WechatContact

mapped_id

mapped_id 代表的是各個管道帳號的對應識別編號。以 LINE 官方帳號為例,假如有以下 2 筆串接資料:

  1. 大安門市

  2. 萬華門市

當傳入的 mapped_id 為 2 時,表示您正在篩選的是「萬華門市」。

contact_id

對應管客戶系統識別編號,如 2635、154 等

created_at

資料建立日期,如 2023-04-05 00:00:00

Response

回傳為 JSON 格式,而 HTTP status 為代碼 200,表示發送成功。

屬性
介紹

id

識別編號

name

暱稱

picture_url

圖片 URL

contact

客戶資訊

mapped.id

對應的管道帳號識別編號

mapped.name

管道帳號名稱

state

狀態

is_visible

是否可見

created_at

建立日期和時間

updated_at

更新日期和時間

{
    "data": [
        {
            "id": 1,
            "name": "暱稱",
            "picture_url": null,
            "contact": null,
            "mapped": {
                "id": 1,
                "name": "管道帳號"
            },
            "state": 0,
            "is_visible": true,
            "created_at": "2018-11-11 01:53:39",
            "updated_at": "2018-11-11 01:53:39"
        }
    ]
}

Last updated