MessageMedia Webhooks允许您订阅一个或多个事件,当其中一个事件被触发时,将向您选择的URL发送一个HTTP请求以及消息或负载。简单地说,它允许应用程序相互“说话”,并在发生新的事情时自动得到通知。

messagemedia-webhooks-sdk的Python项目详细描述


##如何构建 < BR>< BR>
必须在系统上安装python``2>;=2.7.9``或python``3>;=3.4```才能安装和运行此sdk。这个sdk包依赖于其他python包,如nose、jsonpickle等。
这些依赖项在sdk附带的"requirements.txt"文件中定义。
要解决这些依赖关系,可以使用pip依赖关系管理器。按照[https://pip.pypa.io/en/stable/installing/]中的步骤安装(https://pip.pypa.io/en/stable/installing/)。 < BR>
应在路径中定义python和pip可执行文件。打开命令提示符并键入``pip--version``。
如果安装成功并正确定义了路径,则应显示安装的pip依赖关系管理器的版本。 < BR>
*使用命令行,导航到包含为sdk生成的文件(包括``requirements.txt```)的目录。
*运行命令"pip install-r requirements.txt"。这将安装所有必需的依赖项。 < BR>
![构建sdk-步骤1](https://apidocs.io/illustration/python?步骤=installdependencies&workspacefolder=messagemediawebhooks python) < BR>< BR>
如何使用 < BR>
以下部分说明如何在新项目中使用MessageMediaWebHooks SDK包。 < BR>
1。在IDE中打开项目 < BR>
打开python ide,比如pycharm。如果您喜欢使用不同的编辑器或IDE,这里提供的基本工作流也适用。 < BR>
![在PyCharm中打开项目-步骤1](https://apidocs.io/illustration/python?步骤=Pycharm) < BR>
单击pycharm中的"open",浏览生成的sdk目录,然后单击"ok"。 < BR>
![在PyCharm中打开项目-第2步](https://apidocs.io/illustration/python?步骤=openproject0&workspacefolder=messagemediawebhooks python) < BR>
项目文件将显示在侧栏中,如下所示: < BR>
![在PyCharm中打开项目-第3步](https://apidocs.io/illustration/python?步骤=openproject1&workspacefolder=message media webhooks python&;projectname=message_media_webhooks) < BR>
2。添加新的测试项目 < BR>
右键单击解决方案名称创建新目录,如下所示: < BR>
![在PyCharm中添加新项目-步骤1](https://apidocs.io/illustration/python?step=createdirectory&workspacefolder=message media webhooks python&;projectname=message_media_webhooks) < BR>
将目录命名为"test" < BR>
![在PyCharm中添加新项目-步骤2](https://apidocs.io/illustration/python?步骤=名称目录) < BR>
将一个名为"testsdk"的python文件添加到此项目中 < BR>
![在PyCharm中添加新项目-步骤3](https://apidocs.io/illustration/python?step=createfile&workspacefolder=message media webhooks python&;projectname=message_media_webhooks) < BR>
将其命名为"testsdk" < BR>
![在PyCharm中添加新项目-步骤4](https://apidocs.io/illustration/python?步骤=名称文件) < BR>
在python文件中,需要使用以下代码行导入生成的python库 < BR>
``巨蟒
从消息媒体webhooks.message媒体webhooks客户端导入消息媒体webhooks client
``` < BR>
![在PyCharm中添加新项目-步骤4](https://apidocs.io/illustration/python?step=projectfiles&workspacefolder=messagemediawebhooks python&;libraryname=m消息媒体网络挂钩。消息媒体网络挂钩客户端项目名称=消息媒体网络挂钩类名称=消息媒体网络挂钩客户端) < BR>
在此之后,您可以编写代码来实例化api客户机对象、获取控制器对象并进行api调用。示例代码在后面的章节中给出。 < BR>
3。运行测试项目 < BR>
要在测试项目中运行该文件,请右键单击测试项目中的python文件,然后单击"运行"``` < BR>
![运行测试项目-步骤1](https://apidocs.io/illustation/python?step=runproject&;workspacefolder=message media webhooks python&;libraryname=message_media_webhooks.message_media_webhooks_client&;projectname=message_media_webhooks&classname=messagemediawebhooksclient) < BR>< BR>
如何测试 < BR>
您可以使用自动生成的测试来测试生成的sdk和服务器
案例。unittest作为测试框架,nose作为测试
跑步者。您可以按如下方式运行测试: < BR>
1.从terminal/cmd导航到sdk的根目录。
2.调用``pip install-r test requirements.txt```
3.调用"nosetests"``` < BR>
初始化 < BR>
认证
要设置api客户端的身份验证和初始化,需要以下信息。 < BR>
参数说明|
-|
基本身份验证用户名|
基本身份验证密码| < BR>< BR>< BR>
API客户端可以初始化如下。 < BR>
``巨蟒
配置参数和凭据
basic_auth_user_name='basic_auth_user_name'用于基本身份验证的用户名
basic_auth_password='basic_auth_password'用于基本身份验证的密码 < BR>
客户端=MessageMediaWebHooksClient(基本身份验证用户名、基本身份验证密码)
``` < BR>< BR>< BR>
类引用 < BR>
控制器列表 < BR>
*[webhooks controller]("webhooks"控制器) < BR>
[类:](https://apidocs.io/img/class.png".webhookscontroller")webhookscontroller < BR>
获取控制器实例 < BR>
可以从api客户端访问"webhookscontroller"类的实例。 < BR>
``巨蟒
webhooks_controller=客户端.webhooks
``` < BR>
[方法:](https://apidocs.io/img/method.png".webhookscontroller.create_webhook")创建Webhook < BR>
>;为一个或多个指定事件创建Webhook。
>;webhook通常具有以下结构:
>;。```
>;{
>;"url":"http://webhook.com",
>;"方法":"发布",
>;"编码":"json",
>;"标题":{
>;"帐户":"developerPortal7000"
>;},
>;"事件":[
>;"收到短信"
>;],
>;"模板":"{\"id\":\"$mtid\",\"status\":\"$statuscode\"}"
>;}
>;。```
>;有效的webhook必须包含以下内容性能:
>;-```url``当选定事件发生时触发Webhook的配置URL。
>;-``方法``将CRUD(创建、检索、更新、删除)操作映射到HTTP请求的方法。
>;-``编码``返回有效负载的格式。您可以从``json``````格式编码``或``xml``中选择。这将自动为您添加内容类型标题,因此您不必在"headers"属性中再次添加它。
>;-`` headers`` http header字段,提供有关请求或响应或消息正文中发送的对象的必需信息。这不应包括"content type"标题。
>;-```事件``将触发webhook的事件。至少应出现一个事件。
>;-``模板``将返回的负载结构。
>;事件类型
>;您可以选择所有事件(下面列出)或以任何方式组合它们,但至少必须使用一个事件。否则,将不会创建webhook。
>;一个或多个事件发生时将触发Webhook:
>;+**短信息**
>;+`Received\u sms`接收短信
>;+`opt_out_sms`opt out发生
>;+**彩信**
>;+`Received_mms`接收彩信
>;+**灾难恢复(交付报告)**
>;+`ENROUTE_dr`消息正在途中
>;+`expired\u dr`消息已过期
>;+"拒绝"消息被拒绝
>;+`failed\u dr`消息已失败
>;+"已传递"邮件已传递
>;+"已提交"邮件已提交
>;模板参数
>;您可以选择将通过webhook作为有效负载发送的数据中包含的内容。
>;请记住,必须在模板值中转义json(请参见上面的示例)。
>;该表显示了可包含在模板中的所有参数以及可应用于哪些事件类型的列表。
>;数据参数名称示例事件类型|
>;:--|--|--|--|--|
>;**服务类型**$type `sms` `dr``mo``mo-mms`|
>;**消息ID**$MTID,$MessageID `877C19EF-FA2E-4CEC-827A-E1DF9B5509F7` `DR``MO``MO MMS`|
>;**交货报告编号**$dr id,$reportid `01e1fa0a-6e27-4945-9cdb-18644b4de043 ` `dr`|
>;**回复id**$moid,$replyid `a175e797-2b54-468b-9850-41a3eab32f74` `mo``mo mms`|
>;**帐户ID**$accountID `developerPortal7000``dr``mo``mo彩信`|
>;**消息时间戳**$submittedTimestamp `2016-12-07t08:43:00.850z ` `dr``mo``mo mms`|
>;**提供商时间戳**$receivedTimestamp `2016-12-07t08:44:00.850z ``dr``mo``mo mmsms`|
>;**消息状态**$status"途中""dr`|
>;**状态码**$status code `200 `dr`|
>;**外部元数据**$metadata.get('key')`name``dr``mo``mo mms`|
>;**源地址**$source address `+61491570156 ` `dr``mo``mo-mms`|
>;**目的地地址**$destination address `+61491593156 ` `mo``mo-mms`|
>;**信息内容**$mtcontent,$message content `hi derp` `dr``mo``mo彩信`|
>;**回复内容**$mo content,$replycontent `hello derpina` `mo``mo彩信`|
>;**重试次数**$retry count `1``dr``mo``mo mms`|
>;*注意:如果"url"无效、"events"、"encoding"或"method"为空或"headers"h,则返回400响应作为内容类型属性。* < BR>
``巨蟒
定义创建webhook(self,
车身)
``` < BR>
参数 < BR>
参数标记说明|
-|
body ``必选```` TOdo:添加参数说明| < BR>< BR>< BR>
示例用法 < BR>
``巨蟒
正文=创建Webhookrequest() < BR>
result=webhooks_controller.create_webhook(主体) < BR>
``` < BR>
错误 < BR>
错误代码错误描述|
---|
400 API调用中出现意外错误。有关详细信息,请参阅http响应正文。γ
409 API调用中出现意外错误。有关详细信息,请参阅http响应正文。γ < BR>< BR>< BR>< BR>
[方法:](https://apidocs.io/img/method.png".webhookscontroller.retrieve_webhook")检索_webhook < BR>
>;检索为连接的帐户创建的所有webhook。
>;对检索Webhook终结点的成功请求将返回响应正文,如下所示:
>;。```
>;{
>;"第页":0,
>;"页面大小":100,
>;"页面数据":[
>;{
>;"url":"https://webhook.com",
>;"方法":"发布",
>;"id":"8805C9D8-BEF7-41C7-906A-69EDE93AA024",
>;"编码":"json",
>;"事件":[
>;"收到短信"
>;],
>;"标题":{},
>;"模板":"{\"id\":\"$mtid\",\"status\":\"$statuscode\"}"
>;}
>;]
>;}
>;。```
>;*注意:当"page"查询参数无效或"pagesize"查询参数无效时,将返回响应400。* < BR>
``巨蟒
定义检索Webhook(self,
第页=无,
页面大小=无)
``` < BR>
参数 < BR>
参数标记说明|
-|
page ``` optional ````` todo:添加参数说明|
pagesize ``可选```` TOdo:添加参数说明| < BR>< BR>< BR>
示例用法 < BR>
``巨蟒
第85页
页面大小=85 < BR>
result=webhooks_controller.retrieve_webhook(页面,页面大小) < BR>
``` < BR>
错误 < BR>
错误代码错误描述|
---|
400 API调用中出现意外错误。有关详细信息,请参阅http响应正文。γ < BR>< BR>< BR>< BR>
[方法:](https://apidocs.io/img/method.png".webhookscontroller.delete-webhook")删除-webhook < BR>
>;删除以前为连接的帐户创建的Webhook。
>;可以通过将webhook的uuid附加到终结点并向/webhooks/messages终结点提交删除请求来取消webhook。
>;*注意:只能删除预先创建的webhook。如果在请求中指定了无效或不存在的webhook id参数,则将返回http 404 not found响应。* < BR>
``巨蟒
定义删除Webhook(self,
网络挂钩
``` < BR>
参数 < BR>
参数标记说明|
-|
webhookid ``必需` ` ` todo:添加参数说明| < BR>< BR>< BR>
示例用法 < BR>
``巨蟒
webhook_id=a7f11bb0-f299-4861-a5ca-9b29d04bc5ad < BR>
webhook_controller.delete_webhook(webhook_id) < BR>
``` < BR>
错误 < BR>
错误代码错误描述|
---|
404 TOdo:添加错误描述| < BR>< BR>< BR>< BR>
[方法:](https://apidocs.io/img/method.png".webhookscontroller.update-webhook")更新-webhook < BR>
>;更新网络挂钩。您可以通过向/webhooks/messages端点(与上面用于删除webhook的端点相同)提交修补程序请求来更新单个或所有属性。
>;对检索Webhook终结点的成功请求将返回响应正文,如下所示:
>;。```
>;{
>;"url":"https://webhook.com",
>;"方法":"发布",
>;"id":"04442623-0961-464E-9CBC-EC50804e0413",
>;"编码":"json",
>;"事件":[
>;"收到短信"
>;],
>;"标题":{},
>;"模板":"{\"id\":\"$mtid\",\"status\":\"$statuscode\"}"
>;}
>;。```
>;*注意:只能删除预先创建的webhook。如果在请求中指定了无效或不存在的webhook id参数,则将返回http 404 not found响应。* < BR>
``巨蟒
def update_webhook(自我,
网络挂钩ID,
车身)
``` < BR>
参数 < BR>
参数标记说明|
-|
webhookid ``必需` ` ` todo:添加参数说明|
body ``必选```` TOdo:添加参数说明| < BR>< BR>< BR>
示例用法 < BR>
``巨蟒
webhook_id=a7f11bb0-f299-4861-a5ca-9b29d04bc5ad
正文值="{\"url\":\"https://myurl.com\",\"方法\":\"post\",\"编码\":\"表单\",\"事件\":[\"途中\",\"模板\":\"{\\"id\\":\\"$mtid\\",\\"状态\":\\"$statuscode\\"}"
body=json.loads(body_值) < BR>
结果=webhooks_controller.update_webhook(webhook_id,body) < BR>
``` < BR>
错误 < BR>
错误代码错误描述|
---|
400 API调用中出现意外错误。有关详细信息,请参阅http响应正文。γ
404 TOdo:添加错误描述| < BR>< BR>< BR>< BR>
[返回控制器列表](控制器列表) < BR>< BR>< BR>< BR>
平台:未知 < BR>

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何在jetty请求日志中添加milliscond字段?   java在使用Scanner类从文件读取信息时遇到问题   为什么。类不适用于泛型类型?   SQLite插入上的java空指针异常   java能告诉我们Guava缓存是在禁用统计数据的情况下构建的吗?   java在应用程序中使用常量   java无法使用AutoIT和Selenium Webdriver在所需位置/文件夹保存图像   java如何在jtable中更新jprogress栏   java是比较给定日期和当前日期(在给定时区中没有时间段)的最佳方法   安卓代码中的java错误   java无法访问实体类中的字段   java如何在tomcat中处理三个JDBC连接池?   java无法使用Spring Security保护AngularJS页面   如何在没有TCP/IP协议栈的情况下用Java发送以太帧