1. 服务端接口

1.1. 移动认证服务端接口

1.1.1. 获取用户登录手机号码的接口

简要描述

• 获取用户登录手机号码的接口

请求URL

• https://account.linkedme.cc/phone/info

请求方式

• POST+json,Content-type设置为application/json

请求参数

{
    "header": {
        "Content-type": application/json,
    },
    "body": {
       "channel":"1",
       "platform":"0",
       "app_key":"99bfd12b542b36ad35ea378a07edf349",
       "auth_code":"1234",
       "token":"nm899e6f8f32b44f81972cbe28ca01623a",
       "sign":"4B36329C1429512FD24C2C460065F677D3521EC56A91370AFF40E65990AF74C7D12C9F0E6061D2E2C6FE022B66CCD23554249ECA13D5F8FB0E8C7459DD6D25A0309FD6AE73D4918E45EAF85AB7D4DA942B3664966B92CEFC57B7B28CC4EE57186A1B27860FF74698FE6307A85F0DD9D3A13A34397CB8F4F921DC3869BAA9B80"
    }
}

返回参数

返回示例

{
      "header": {
        "code": 200,
        "msg": "操作成功",
        "time": 1561690611021
                 },
      "body": "4B36329C1429512FD24C2C460065F677D3521EC56A91370AFF40E65990AF74C7D12C9F0E6061D2E2C6FE022B66CCD23554249ECA13D5F8FB0E8C7459DD6D25A0309FD6AE73D4918E45EAF85AB7D4DA942B3664966B92CEFC57B7B28CC4EE57186A1B27860FF74698FE6307A85F0DD9D3A13A34397CB8F4F921DC3869BAA9B80"
}

时序图

1.1.2. 校验用户登录号码接口

简要描述

• 校验用户登录号码接口

请求URL

• https://account.linkedme.cc/phone/verify

请求方式

• POST+json,Content-type设置为application/json

请求参数

{
    "header": {
        "Content-type": application/json,
    },
    "body": {
       "channel":"1",
       "platform":"0",
       "app_key":"99bfd12b542b36ad35ea378a07edf349",
       "token":"nm899e6f8f32b44f81972cbe28ca01623a",
       "phone_num":"18123972798",                                        
       "sign":"4B36329C1429512FD24C2C460065F677D3521EC56A91370AFF40E65990AF74C7D12C9F0E6061D2E2C6FE022B66CCD23554249ECA13D5F8FB0E8C7459DD6D25A0309FD6AE73D4918E45EAF85AB7D4DA942B3664966B92CEFC57B7B28CC4EE57186A1B27860FF74698FE6307A85F0DD9D3A13A34397CB8F4F921DC3869BAA9B80"
    }
}

返回参数

{
      "header": {
         "code": 200,
         "msg": "操作成功",
         "time": 1561690611021
                 },
      "body": "4B36329C1429512FD24C2C460065F677D3521EC56A91370AFF40E65990AF74C7D12C9F0E6061D2E2C6FE022B66CCD23554249ECA13D5F8FB0E8C7459DD6D25A0309FD6AE73D4918E45EAF85AB7D4DA942B3664966B92CEFC57B7B28CC4EE57186A1B27860FF74698FE6307A85F0DD9D3A13A34397CB8F4F921DC3869BAA9B80"
}

时序图

1.1.3. 平台返回码说明

1.2. 短信验证码接口

1.2.1. 短信通知

简要描述

· 使用短信通知时，调用此API，请求LinkAccount业务平台给指定用户发送短信验证码。

接口类型

表1 接口类型说明

请求参数

表2 请求Header参数说明

表3 请求Body参数说明

请求实例

{ 
"app_key":"7e289a2484f4368dbafbd1e5c7d06903", 
"recipient":"+8613412345678", 
"sign_name":"短信", 
"template_id":"45", 
"template_params":["1224","你好","2019/12/12","12:12"], 
"status_callback_url":"http://requestbin.fullcontact.com/scvavdsc", 
"sign":"226964223a202230313233343536372d383961622d636465662d303
132332d343536373839616263646566222c0d0a2020226e616d65223a20226 
4656d6f617070222c0d0a2020226f776e6572223a207b0d0a2020202022656d 
61696c223a2022757365726e616d65406578616d706c652e636f6d222c0d0a2 
0202020226964223a202230313233343536372d383961622d636465662d3031 
32332d3435363738396162636464ff", 
"extend":"linkedme" 
}

表5 SmsResult 定义

响应实例

 {
    "header": {
        "code": 200,
        "msg": "操作成功",
        "success": true,
        "alert": true,
        "time": 1564486490320
    },
    "body": {
        "result": [
            {
                "smsMsgId": "7524a9aa-19d1-4be6-bef0-2b0ce5dd6107",
                "originTo": "+8613412345678",
                "createTime": 1564486490192,
                "status": "000000"
            }
        ]
    }
}

时序图

平台返回码说明

1.2.2. 短信回调通知

简要描述

· 该接口用于客户接收短信平台主动发送的短信状态报告

· 请求方向 :LinkAccount业务平台 → 客户服务器

· 使用前提: 开发者在开发应用时，若需订阅状态通知，必须要提供状态接收URL（status_callback_url），并且确保URL能够正常处理LinkAccount业务平台发送的通知信息

· 使用限制: 仅支持POST方式

表1 接口类型说明

表2 请求Body参数说明

请求实例

{
     "smsMsgId":"e1f27fd2-59cb-4827-b926-4550856e2c44",
     "total": "1",
     "sequence": "1",
     "status": "1300001",
     "msg": "用户已成功收到短信",
     "source": "2",
     "updateTime": "2019-07-27",
     "extend": "linkedme",
     "to": "+8613412345678"
}

平台返回码说明

1.3. 语音验证码接口

1.3.1. 语音通知

简要描述

· 使用语音通知功能时,调用此API,请求LinkAccount业务平台给指定用户播放语音通知。

接口类型

表1 接口类型说明

请求参数

表2 请求Header参数说明

表3 请求Body参数说明

请求实例

{
  "recipient": "15970704470",
  "app_key": "7e289a2484f4368dbafbd1e5c7d06903",
  "status_callback_url": "http://requestbin.fullcontact.com/scvavdsc",
  "extend": "linkedme",                  
 "sign":"226964223a202230313233343536372d383961622d636465662d30
   3132332d343536373839616263646566222c0d0a2020226e616d65223a2
   02264656d6f617070222c0d0a2020226f776e6572223a207b0d0a202020
   2022656d61696c223a2022757365726e616d65406578616d706c652e63
   6f6d222c0d0a20202020226964223a202230313233343536372d383961
   622d636465662d303132332d3435363738396162636464ff",
   "template_id": "TTS01",
   "template_params": [
        "2222"
     ]   
}

响应参数

表4响应结果参数

响应实例

 {
    "header": {
        "code": 200,
        "msg": "操作成功",
        "success": true,
        "alert": true,
        "time": 1564108757224
    },
    "body": {
        "sms_msg_id": "977713dc-386b-4a3e-b6a0-a783629c2c87",
        "status": "000000"
    }
}

时序图

平台返回码说明

1.3.2. 语音回调通知

简要描述

· 用户通话结束后，LinkAccount业务平台通过此接口向SP推送通话的状态信息
**· 请求方向 :LinkAccount业务平台（客户端） → 客户服务器（服务端）
· 使用前提: 开发者在开发应用时，若需订阅状态通知，必须要提供状态接收URL（status_callback_url），并且确保URL能够正常处理LinkAccount业务平台发送的通知信息
· 使用限制: LinkAccount业务平台推送话单信息给开发者应用，仅支持POST方式

表1 接口类型说明

表2 请求Body参数说明

请求实例

{
    "msgId": "11fb06c3-b5ca-4822-99fe-15000cc43d83",
    "status": 0,
    "callerNum": "+8631180985016",
    "to": "+86134123456578",
    "callOutStartTime": "2019-07-29 06:27:08",
    "callEndTime": "2019-07-29 06:27:21",
    "extend": "linkedme"
}

平台返回码说明