Text messages

Note

此页面的内容需要进行重大更新。旧页面包含过时且可能不准确的信息。您仍然可以通过 Mautic Developer Documentation archived repository 访问它。

如果您有兴趣帮助开发此页面和其他新内容的，请考虑加入文档编写工作。

请阅读 Contributing Guidelines 和 Contributing to Mautic’s documentation 以开始您的贡献。

使用此端点获取有关 Mautic 短信（SMS）的详细信息。

短信属性

在 POST 请求中创建短信时，请使用以下属性。这些属性也用于列出或获取短信时返回。

Name	Type	Description
`id`	int	短信的 ID
`name`	string	短信标题
`message`	string	短信内容
`isPublished`	boolean	发布状态
`publishUp`	datetime/null	SMS 发布日期/时间
`publishDown`	datetime/null	SMS 下线日期/时间
`dateAdded`	`datetime`	创建短信的日期/时间
`createdBy`	int	创建短信的用户 ID
`createdByUser`	string	创建短信用户的姓名
`dateModified`	datetime/null	最后修改短信的日期/时间
`modifiedBy`	int	最后修改短信的用户 ID
`modifiedByUser`	string	最后修改短信用户的姓名
`language`	string	短信的语言区域设置
`sentCount`	int	短信发送次数

使用 Mautic API 库

您可以通过 Mautic API Library 以以下方式与此 API 进行交互，或者可以使用本文档中描述的各种 HTTP 端点。

<?php
use Mautic\MauticApi;
use Mautic\Auth\ApiAuth;

// ...
$initAuth = new ApiAuth();
$auth     = $initAuth->newAuth($settings);
$apiUrl   = "https://example.com";
$api      = new MauticApi();
$smsApi   = $api->newApi("smses", $auth, $apiUrl);

获取短信

<?php

//...
$sms = $smsApi->get($id);

通过 ID 获取单个 SMS。

HTTP 请求

GET /smses/ID

响应

Expected Response Code: 200

```json {

“sms”:{
“isPublished”:true, “dateAdded”:”2016-09-14T12:14:45+00:00”, “createdBy”:1, “createdByUser”:”Wu Popovski”, “dateModified”:null, “modifiedBy”:null, “modifiedByUser”:null, “id”:1, “name”:”Message A”, “message”:”Hello”, “language”:”en”, “category”:null, “publishUp”:null, “publishDown”:null, “sentCount”:0

}

}

列出短信

<?php
// ...

$smses = $smsApi->getList($searchFilter, $start, $limit, $orderBy, $orderByDir, $publishedOnly, $minimal);

HTTP 请求

GET /smses

查询参数

Name	Description
`search`	用于过滤实体的字符串或搜索命令。
`start`	返回实体的起始行。默认为 0。
`limit`	要返回的实体数量限制。默认为分页系统的配置，该配置默认为 30。
`orderBy`	用于排序的列。可以使用响应中列出的任何列。
`orderByDir`	排序方向：`asc` 或 `desc`。
`publishedOnly`	仅返回当前已发布的实体。
`minimal`	仅返回实体数组，不包含其他列表。

响应

Expected Response Code: 200

{
    "total":1,
    "smses":[
        {
            "isPublished":true,
            "dateAdded":"2016-09-14T12:14:45+00:00",
            "createdBy":1,
            "createdByUser":"Kevin Bulgarelli",
            "dateModified":null,
            "modifiedBy":null,
            "modifiedByUser":null,
            "id":1,
            "name":"Message A",
            "message":"Hello",
            "language":"en",
            "category":null,
            "publishUp":null,
            "publishDown":null,
            "sentCount":0
        }
    ]
}

属性

请参阅本文档顶部的“短信属性”。

创建短信

<?php

$data = array(
    'name'        => 'Text message A',
    'message' => 'This is my first sms created via API.',
    'isPublished' => 1
);

$sms = $smsApi->create($data);

创建新的短信。

HTTP 请求

POST /smses/new

POST 参数

请参阅本文档顶部的“短信属性”。

响应

Expected Response Code: 201

属性

请参阅本文档顶部的“短信属性”。

编辑短信

<?php

$id   = 1;
$data = array(
    'name'        => 'New sms name',
    'isPublished' => 0
);

```

// 创建新短信时，如果 ID 为 1 的短信不存在？

$createIfNotFound = true;

$sms = $smsApi->edit($id, $data, $createIfNotFound);

编辑现有短信。请注意，这支持 PUT 或 PATCH，具体取决于所需的行为。

PUT 如果给定 ID 不存在，则会创建一个短信，并清除所有短信信息，然后添加来自请求的信息。 PATCH 如果具有给定 ID 的短信不存在，则会失败，并且使用来自请求的值更新短信字段值。

HTTP 请求

要编辑一个短信，并在未找到该短信时返回 404：

PATCH /smses/ID/edit

要编辑一个短信，如果未找到该短信，则创建一个新短信：

PUT /smses/ID/edit

PUT/PATCH 参数

Name	Type	Description
`id`	int	短信的 ID
`name`	string	短信标题
`message`	string	短信内容
`isPublished`	boolean	发布状态
`publishUp`	datetime/null	短信应发布的日期/时间
`publishDown`	datetime/null	短信应取消发布的日期/时间
`language`	string	短信的语言区域设置

响应

如果使用 PUT，则预期的响应代码为 200，表示已编辑短信，或者为 201，表示已创建新短信。

如果使用 PATCH，则预期的响应代码为 200。

属性

请参阅此文档顶部的“文本消息属性”。

删除短信

<?php

$sms = $smsApi->delete($id);

删除一个短信。

HTTP 请求

DELETE /smses/ID/delete

响应

预期响应代码：200

属性

请参阅此文档顶部的“文本消息属性”。

向联系人发送短信

<?php

$sms = $smsApi->sendToContact($smsId, $contactId);

将预定义的短信发送给现有联系人。

HTTP 请求

GET /smses/ID/contact/CONTACT_ID/send

响应

预期响应代码：200

属性

{
    "success": 1,
    "status": "Delivered"
}