文档中心 > API类目 > 菜鸟无线API

cainiao.guoguo.im.courier.registerlogin (IM登录注册接口)

IM用户登录注册

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param_user_login_request UserLoginRequest 必须 用户对象
  • └ device_id
  • String
  • 必须
  • t123321
  • 用户设备环境
  • └ employee_no
  • String
  • 可选
  • G123
  • 工号
  • └ cp_code
  • String
  • 必须
  • RRS
  • 企业CODE
  • └ company
  • String
  • 必须
  • 日日顺
  • 企业名称
  • └ mobile
  • String
  • 可选
  • 13858100542
  • 用户手机号
  • └ login_id
  • String
  • 必须
  • evatses
  • 会员名
  • └ name
  • String
  • 必须
  • 张三
  • 姓名
  • └ user_agent
  • String
  • 必须
  • {"client_type":"ios"}
  • 用户客户端信息
  • └ user_type
  • Number
  • 可选
  • 1
  • 用户类型
client_type String 必须 iOS 客户端类型
sdk_version String 必须 3.1.4 SDK版本号
user_agent String 可选 {"client_type":"ios"} 用户客户端信息
alipay_auth_code String 可选 abc 支付宝授权码(可选,如果填入则会校验)

响应参数

名称 类型 示例值 描述
data UserLoginResponse data data
  • └ avatar_url
  • String
  • http://a.png
  • avatarUrl
  • └ cn_user_id
  • Number
  • 42312321
  • cnUserId
  • └ nick
  • String
  • 张三
  • nick
  • └ refresh_token
  • String
  • 90
  • refreshToken
  • └ session_id
  • String
  • 123321
  • sessionId
status_code String PARAM_ERROR statusCode
status_message String INVALID statusMessage
is_success Boolean false success

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoImCourierRegisterloginRequest req = new CainiaoGuoguoImCourierRegisterloginRequest();
CainiaoGuoguoImCourierRegisterloginRequest.UserLoginRequest obj1 = new CainiaoGuoguoImCourierRegisterloginRequest.UserLoginRequest();
obj1.setDeviceId("t123321");
obj1.setEmployeeNo("G123");
obj1.setCpCode("RRS");
obj1.setCompany("日日顺");
obj1.setMobile("13858100542");
obj1.setLoginId("evatses");
obj1.setName("张三");
obj1.setUserAgent("{\"client_type\":\"ios\"}");
obj1.setUserType(1L);
req.setParamUserLoginRequest(obj1);
req.setClientType("iOS");
req.setSdkVersion("3.1.4");
req.setUserAgent("{\"client_type\":\"ios\"}");
req.setAlipayAuthCode("abc");
CainiaoGuoguoImCourierRegisterloginResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_guoguo_im_courier_registerlogin_response>
    <data>
        <avatar_url>http://a.png</avatar_url>
        <cn_user_id>42312321</cn_user_id>
        <nick>张三</nick>
        <refresh_token>90</refresh_token>
        <session_id>123321</session_id>
    </data>
    <status_code>PARAM_ERROR</status_code>
    <status_message>INVALID</status_message>
    <is_success>false</is_success>
</cainiao_guoguo_im_courier_registerlogin_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部