yunpian-python-sdk

云片 SDK

快速开始

• 安装SDK

  pip install yunpian-python-sdk

  注: master是最新稳定版,发布版本见PyPI

• 使用YunpianClient

  from yunpian_python_sdk.model import constant as YC
  from yunpian_python_sdk.ypclient import YunpianClient
  # 初始化client,apikey作为所有请求的默认值
  clnt = YunpianClient('apikey')
  param = {YC.MOBILE:'18616020***',YC.TEXT:'【云片网】您的验证码是1234'}
  r = clnt.sms().single_send(param)
  # 获取返回结果, 返回码:r.code(),返回码描述:r.msg(),API结果:r.data(),其他说明:r.detail(),调用异常:r.exception()
  # 短信:clnt.sms() 账户:clnt.user() 签名:clnt.sign() 模版:clnt.tpl() 语音:clnt.voice() 流量:clnt.flow()

注: v1.0.0不兼容之前版本0.0.8

配置说明 (默认配置就行)

• 构造器配置
  • YunpianClient('apikey')
  • YunpianClient('apikey',conf), conf字典key详见model.constant.YP_*
• apikey的优先级:接口的param[APIKEY] > 构造器的apikey > 构造器的conf[YP_APIKEY]

源码说明

• 接口参数的apikey可以不传，因为所有接口默认传入`YunpianClient`构造时的apikey
• 接口默认使用v2版本,可以在调用时指定版本,如clnt.sms().version('v1').single_send(param)
• API单元测试目录tests,支持tox
• 分支说明: master是最新发布版本,develop是待发布的分支(开源贡献可以pull request到develop分支)

联系我们

云片支持 QQ

SDK开源QQ群: 106469530

文档链接

• API文档

可选SDK

• https://github.com/yunpian/sms/tree/master/yunpian/python/ypclient 支持py2/3