探马OpenAPI

一键拨号

POST

/api/v3/app/starCall

注意

电销app2.1.28,销售助手1.1.48 版本以上，才会返回callId。

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

mobile

string

要呼出的电话

必需

salesId

number

员工ID

可选

salesId和qwUserId任选其一，不能同时为空

qwUserId

string

企微员工ID

可选

salesId和qwUserId任选其一，不能同时为空

externalId

string

外部指定唯一ID

可选

调用方可自己指定外部唯一ID，接口响应成功返回该ID，并返回本次通话事件的callId

示例

{
  "mobile": "18663341811",
  "qwUserId": "35",
  "salesId": 69
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/app/starCall' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mobile": "18663341811",
    "qwUserId": "35",
    "salesId": 69
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

callId

string

通话ID

必需

电销app2.1.28，销售助手1.1.48版本以上

externalId

string

调用方指定的唯一ID

可选

当调用方请求接口并指定externalId时，响应时会返回该externalId（电销app2.1.28，销售助手1.1.48版本以上）

示例

{
  "code": 0,
  "message": "ok",
  "data": {
    "callId": "tm11223344",
    "externalId": "ext11223344"
  }
}

按内容访问时间列出访客事件信息

接口说明