目录

短信使用


签名与模板

开发者在购买短信服务包之后可进行短信签名和模板设置,只有正确配置了签名和模板并通过审核后才可以进行短信发送。

验证码/通知类签名设置

1. 短信签名要求

2. 短信签名个数

3. 签名审核时间

验证码/通知类模板设置

1. 短信模板要求

2. 短信模板个数

3. 短信模板审核时间

营销类签名和模板设置

只有通过企业认证的用户才可以使用营销类短信,发送营销类短信之前必须单独创建和设置类型为“推广短信”的签名和模板,创建与设置方法同验证码/通知类短信相似,区别在于营销类短信模板不支持变量,在发送营销短信时必须选择推广短信类型的签名和模板才能发送成功。

接口说明

获取org管理员token

获取短信token时需要org管理员的token,以下是org管理员token获取方式:

【请注意,不需要每次获取短信token都去获取org管理员token,只有在接口返回401错误时才需要重新获取org管理员token。】

{"Content-Type":"application/json"} 
{"grant_type":"password","username":"{org_admin}","password":"{org_admin_password}"} 

【org_admin为org管理员账号,即登录Console时使用的管理员账号;org_admin_password为org管理员密码。】

curl 示例:

curl -X POST -d '{"grant_type":"password","username":"admin_of_easemob","password":"xxxx"}' "https://a1.easemob.com/management/token"

Response 示例:

{
    "access_token": "YWMt1Kz72HakEee9Jqe_xuAMZwAAAV7SWO7rk7M8CSVEBYUXNYvZCsXBjk7D4ZY",
    "expires_in": 5183999,
    "user": {
        "adminUser": true,
        "created": 1501583341002
        ...
    }
    ...
}

其中access_token字段为org管理员token。

获取短信token

发送短信时需要在请求头域填充token字段,此token为短信服务专用token,以下是短信token获取方式。

【请注意,不需要在每次发送短信时都获取短信token,只有在接口返回401错误时才需要重新获取短信token。】

{"username":"{org_admin}","token":"{org_token}"}

【org_admin为org管理员账号,org_token为org管理员token。】

curl 示例:

curl -X POST --header "username: admin_of_easemob-demo" --header "token: YWMtmR3eKntAEeepn2lE8ohMwAAAAAAAAAAAAAAAAAAAAAGP-MBq3AgR45fkRZpPlqEwAQMAAAFdu48YFABPGgCEBL6K_xLcscr3f44YBdykhA3f3B5uqw424q_xxxxxx" "https://sms.easemob.com/easemob-demo/chatdemoui/token"

Response 示例:

{"errorCode":0,"data":{"org":"easemob-demo","app":"chatdemoui","createdTime":1505178552823,"modifiedTime":1505178552823,"tokenKey":"201709120909","token":"a5bb2ec5-9120-4e57-87e9-3c56d5b4948e"}}

【其中org为Console中应用详情页面下的OrgName;app为Console中应用详情页面下的AppName;token字段为短信token。】

发送短信

{"token":"{sms_token}","Content-Type": "application/json", "Accept": "*/*"} 

【sms_token为短信token。】

{ 
  "orderId": "ZpAAAFdu48YZpPlqEwAPlqEwAQMQMAAAFdu48Y",
  "params": "var1=xxx&var2=yyy",
  "receiver": "13811103453",
  "sign": "环信",
  "templateCode": "080b541a-63e9-467f-b5f5-a3bc5de4bd7d"
}

curl 示例:

curl -X POST  --header "Content-Type: application/json" --header "Accept: */*" --header "token: 8ce15ea0-81c1-4012-9fd9-7c2f2eab0743" -d "{
  \"orderId\": \"ZpAAAFdu48YZpPlqEwAPlqEwAQMQMAAAFdu48Y\",
  \"params\": \"var1=xxx&var2=yyy\",
  \"receiver\": \"133xxxxxxxx\",
  \"sign\": \"环信\",
  \"templateCode\": \"080b541a-63e9-467f-b5f5-a3bc5de4bd7d\"
}" "https://sms.easemob.com/easemob-demo/chatdemoui/sms_send"

Response 示例:

{
    "errorCode": 0,
    "data": {
        "sessionID": "834d5750810c9490359a0d90ab9bbd0a"
    }
}

上一页:短信购买

下一章节:增值服务