phaxio的python客户端
pyphaxio的Python项目详细描述
用于与Phaxio API交互的python模块。
安装
通过PIP:
$ pip install pyphaxio
用法
使用HTML消息向多人发送传真:
fromphaxioimportPhaxioApiapi=PhaxioApi(key,secret)r=api.send(to=['4141234567','5141234567','6151234567'],string_data='Hello World!',string_data_type='text')print(r.get('faxId'))
一般来说,每个受支持的方法都使用 API方法参数的名称与 documentation。此规则的一个例外是filename是 而是被称为files。例如,使用 文件:
llama=os.path.join(os.path.dirname(__file__),'tests/llama.pdf')alpaca=os.path.join(os.path.dirname(__file__),'tests/alpaca.pdf')f=open(alpaca,'rb')r=api.send(to='4141234567',files=(llama,f))
有关其他示例,请参见tests。
错误处理
默认情况下,api调用返回一个字典。但是,您可以使用 PhaxioApi(key, secret, raise_errors=True)这将提高 以下错误:*AuthenticationError-密钥/机密无效* APIError-API调用出错*ServerError-服务器有 错误,无法完成您的请求
可以从phaxio.exceptions模块导入错误
当前支持的api调用
实施和测试:
- 发送
- 测试接收
- 传真状态
- 传真文件
已实现和未测试:
- 附件phaxcodetopdf
- 创建密码
- 获取宿主文档
- 供应编号
- 发布号
- 数学家
- 传真列表
- 传真取消
- 帐户状态
测试
python setup.py test
系统将提示您输入测试api密钥和密钥
贡献
- 叉开它
- 创建功能分支(git checkout -bmy-new-feature)
- 提交更改(git commit -am 'Added some feature')
- 推到分支(git push origin my-new-feature)
- 创建新的拉取请求