座席深度集成

通过使用 PPMESSAGE 的开放 API，可以在您自己的应用中集成 PPMESSAGE 的座席功能。集成座席功能可以方便客户在一个应用环境中既能使用业务应用，也能使用 PPMESSAGE 的座席功能，如和客户之间收发消息。通过深度集成，可以让座席只需登录业务应用，即可访问 PPMESSAGE 的座席功能。

基本概念

PPMESSAGE 的功能都是通过开放接口实现，即使 PPMESSAGE 自己的客服界面也是通过访问这些接口实现。

使用 PPMESSAGE 的开放接口，必须通过 PPMESSAGE 的 OAuth 服务的验证，验证通过后会产生一个 token，拥有这个 token 就可以调用授权给这个 token 的接口了。

每个 PPMESSAGE 注册用户都对应一个团队，这个注册用户为这个团队的拥有者（OWNER），拥有者可以创建座席用户。每个注册用户都可以通过自己的开发者秘钥开发自己的座席软件。

通过秘钥换取 token，通过 token 执行座席登录，座席退出等接口调用，从而实现座席功能。

集成过程

获取开发者秘钥

设置 - 开发者设置 - 开发者秘钥

其中 APP UUID，即团队 UUID，机会每个接口都会需要这个UUID，这样的调用只关注这个团队相关的信息。

Client ID，即客户端 ID，用来标识这个座席客户端。

Client Secret，即客户端秘钥，用来标识这个客户端。

用客户端 ID 和 Secret 可以通过 OAuth 认证的 CLIENT CREDENTIALS 获取 token，具体接口在接口参考中的获取 token。

接口参考

• 接口中除获取 token 接口除外，都需要在 HTTP 请求头中设置 token。形如：
  Authorization:OAuth Zjk4NmVlOTIxY2U2ZWU1ZmM1NGM2MTdiMmQ3ZTVhNWQ3ODE5OTBmNg==
• 除 token 接口外，所有接口返回值都包含 error_code, error_string，error_code 为 0 表示成功，其他值都是失败。
• 除 token 接口外，所有接口都通过一个 URL 进行请求 /ppquery/PP_QUERY，请求数据封装为 JSON，其形式如：

{
  api_url: 接口名称,
  api_data: {
      接口参数对象
  }
}

获取 token

• 接口名称： token
• 接口URL：/ppauth/token
• 请求方式：POST
• 内容类型（Content-Type）：application/x-www-form-urlencoded
• 接口参数：
  "grant_type=client_credentials"
  + "&client_secret=" + window.ppmessage.ppconsole_secret
  + "&client_id=" + window.ppmessage.ppconsole_key;

POST 的数据是上述参数的拼接： "grant_type=client_credentials&client_secret=your_client_secret&client_id=your_client_id"。

• 接口返回：

如果失败，则 HTTP 请求返回 4xx，并且没有 access token。

客服登录

• 接口名称： PPKEFU_LOGIN
• 接口URL：/ppquery/PP_QUERY
• 请求方式：POST
• 内容类型（Content-Type）：application/json
• 接口参数：

    "AND", # ANDROID
    "IOS", # IOS
    "ANB", # ANDROID BROWSER
    "IOB", # IOS BROWSER
    "WIP", # WIN PHONE
    "MAC", # MAC OS X PC
    "LIN", # LINUX PC
    "WIN", # WINDOWS PC
    "MAB", # MAC BROWSER
    "LIB", # LINUX BROWSER
    "WIB", # WINDOWS BROWSER
    "W32", # WINDOWS 32 BIT
    "W64", # WINDOWS 64 BIT

• 接口返回：

客服登出

• 接口名称： PPKEFU_LOGOUT
• 接口URL：/ppquery/PP_QUERY
• 请求方式：POST
• 内容类型（Content-Type）：application/json
• 接口参数：

• 接口返回：

除了错误信息，没有其他返回