短信¶

项目规则行动¶

Program Rule Actions

出站短信服务¶

预测变量

预测变量

Name, ShortName, Description, Generator Description

ValidationRule

ValidationRule

Name, Description, Instruction, Leftside expression, Rightside expression

国际化 { #webapi_i18n }

为了检索翻译字符串的键值对,您可以使用 i18n 资源。

/ api / 33 / i18n

端点位于 /api/i18n 并且请求格式是一个简单的 键值对数组:

网关响应码¶

请求必须是 POST 类型并使用 application/json 作为 内容类型。使用 curl 的示例,假设请求数据已保存 作为文件keys.json:

curl -d @keys.json "play.dhis2.org/demo/api/33/i18n" -X POST
  -H "Content-Type: application/json" -u admin:district

| 结果将如下所示: | json { "access_denied":"Access denied", "uploading_data_notification":"Uploading locally stored data to the server" } | SMS | |---|---|---| | 短消息服务(SMS) { #webapi_sms } | 本节介绍用于发送和接收短文本的 SMS Web API 消息。 | Outbound SMS service | | Web API 支持使用 POST 方法发送外发 SMS。短信可以 发送到单个或多个目的地。一个或多个网关需要 在使用服务之前进行配置。如果出现以下情况,将不会发送短信 没有配置网关。它需要一组接收者和 JSON 格式的消息文本,如下所示。 | / api / sms / outbound | json { "message":"Sms Text", "recipients": [ "004712341234", "004712341235" ] } | | > Note

Recipients list will be partitioned if the size exceeds MAX_ALLOWED_RECIPIENTS limit of 200. | Web API 也支持查询参数版本,但 参数化 API 只能用于发送短信到单个 目的地。 | / api / sms / outbound?message = text&recipient = 004712341234 | | 可以使用GET资源提取出站邮件。 | GET / api / sms / outbound GET / api / sms / outbound?filter = status:eq:SENT GET / api / sms / outbound?filter = status:eq:SENT&fields = * | 可以使用DELETE资源删除出站邮件。 | | 删除/ api / sms / outbound / {uid} 删除/ api / sms / outbound?ids = uid1,uid2 | Gateway response codes | 网关可以使用以下响应代码进行响应。 | | Table: Gateway response codes | Response code | Response Message | | Detail Description | RESULT_CODE_0 | success | | Message has been sent successfully | RESULT_CODE_1 | scheduled | | Message has been scheduled successfully | RESULT_CODE_22 | internal fatal error | | Internal fatal error | RESULT_CODE_23 | authentication failure | | Authentication credentials are incorrect | 本节介绍用于发送和接收短文本的 SMS Web API 消息。 | data validation failed | | Parameters provided in request are incorrect | RESULT_CODE_25 | insufficient credits | | Credit is not enough to send message | RESULT_CODE_26 | upstream credits not available | | Upstream credits not available | RESULT_CODE_27 | exceeded your daily quota | | You have exceeded your daily quota | RESULT_CODE_40 | temporarily unavailable | | Service is temporarily down | RESULT_CODE_201 | maximum batch size exceeded | | Maximum batch size exceeded | RESULT_CODE_200 | success | | The request was successfully completed | RESULT_CODE_202 | accepted | | The message(s) will be processed | RESULT_CODE_207 | multi-status | | 向应用项目接口提交了多条信息,但并非所有信息的状态都相同 | RESULT_CODE_400 | bad request | | Validation failure (such as missing/invalid parameters or headers) | RESULT_CODE_401 | unauthorized |

入站短信服务¶

RESULT_CODE_402

payment required

Not enough credit to send message

RESULT_CODE_404

not found

Resource does not exist

RESULT_CODE_405

method not allowed

Http method is not support on the resource

用法

网关服务管理¶

导入所有未解析的消息

POST /api/sms/入站/导入

Table: User query parameters

Parameter

类型

描述

message

串

This is mandatory parameter which carries the actual text message.

originator

串

This is mandatory parameter which shows by whom this message was actually sent from.

gateway

串

This is an optional parameter which gives gateway id. If not present default text "UNKNOWN" will be stored

网关配置¶

日期

Clickatell{ #clickatell }¶

Gateway service administration

散装¶

可以使用 GET 检索配置的不同网关的列表 方法。

SMPP网关¶

还可以使用特定网关类型检索配置 获取方法。

通用HTTP¶

可以使用 POST 添加新的网关配置。 POST api 需要类型请求参数,目前它的值可以有一个 http,bulksms,clickatell,smpp。第一个添加的网关将设置为默认值。一次只能默认一个网关。默认网关只能通过其 api 更改。如果删除了默认网关,则列表中的下一个网关将自动变为默认网关。

POST / api / 33 / gateways

可以通过提供如下所述的uid和网关配置来更新配置

Url template

header¶

Boolean

If parameter needs to be sent in Http headers

encode

Boolean

If parameter needs to be encoded

key

串

parameter key

价值

串

parameter value

短信命令类型¶

Android的SMS命令类型¶

POST / api / smsCommands