API系列(一):SMS API

简介

你们好,辛苦工作的朋友们!
本文有用之处:
以简约,直白的方式,给未曾接触过短信接口的朋友们,展示一个大概的思路。
本次介绍的是一款来自狮子王国肯尼亚的短信接口方案。由Xcobean 公司提供。
主要使用的技术以REST API风格的接口形式,实现了通讯录(联系人组)管理,联系人管理,短信管理以及WhatsApp短消息管理。
下图是他们的商业版图,可见该公司业务还是挺全面的。
在这里插入图片描述
本文将按照四个章节,依次对各个接口代码进行复制黏贴展示。本文更像是一篇笔记,当然有用之处也在文章开头写了。敬请阅读。欢迎新老朋友指点。花钱找这家公司注册账户,购买api之后,得到两个东西,一个是你的api 站点url,另一个是的token。
在这里插入图片描述

一、 CONTACT GROUPS API

Xcobean SMS Contact Groups API 允许您管理由唯一随机 ID 标识的联系人组。 使用此 ID 创建、查看、更新或删除组。

1. 总概

全部形式 保持统一:
url: https url;
method: GET, POST,PACH,DELETE
header 头部由认证Authorization,内容类型Content-Type,接受类型 Accept。
Authorization 采用 token。在使用Bearer令牌的身份验证流程中,客户端(例如 Web 应用程序或移动应用程序)通过向身份提供者(例如 Google、Facebook 或其他身份提供者)发送请求来获取访问令牌。一旦获取到访问令牌,客户端将在发送每个 API 请求时将该令牌作为 “Authorization” 请求标头的一部分发送到 API。···
content: POST json 请求体
return: 请求返回的json 体

2. Create a group

创建联系人分组,以方便之后批量发送营销信息,像微信一样给联系人上标签,发信息只发给有标签的人。
url: https://sms.xcobean.com/api/v3/contacts
method: post
header:

'Authorization: Bearer ${你的token}'
'Content-Type: application/json' 
'Accept: application/json' 

content:

{
    "name": "Mombasa"
}

return:

{
   "status": "success",
   "message": "Contact group was successfully added",
   "data":    {
      "name": "Mombasa",
      "uid": "645e4dd27b55a"
   }
}

3. View a group

查看分组信息。
url: https://sms.xcobean.com/api/v3/contacts/{group_id}/show/
method: post
parameter: group_id 645e38f3e7e9d
header:

'Authorization: Bearer 8|FMwObDuDLPSAE6YkCB9p1cUjnIs61kECKjVmz111'
'Content-Type: application/json' 
'Accept: application/json' 

return:

{
    "status": "success",
    "message": null,
    "data": {
        "uid": "645e4dd27b55a",
        "name": "Mombasa"
    }
}

4. Update a group

更新分组,使用patch。
url: https://sms.xcobean.com/api/v3/contacts/{group_id}
method: patch
content:

{
    "name": "Kwale"
}

return:

{
    "status": "success",
    "message": "Contact group was successfully updated",
    "data": {
        "name": "Kwale",
        "uid": "645e4dd27b55a"
    }
}

5. Delete a group

删除一个分组。
url: https://sms.xcobean.com/api/v3/contacts/{group_id}
method: delete
parameter:
group_id: 645e38f3e7e9d
return:

{
    "status": "error",
    "message": "Attempt to read property \"id\" on null"
}

6. View all groups

查看所有的分组。
url: https://sms.xcobean.com/api/v3/contacts/{group_id}
method: get
return:

{
    "status": "success",
    "message": null,
    "data": {
        "current_page": 1,
        "data": [
            {
                "uid": "645e4f1be9ad2",
                "name": "Kilifi"
            }
        ],
        "first_page_url": "https://sms.xcobean.com/api/v3/contacts?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://sms.xcobean.com/api/v3/contacts?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://sms.xcobean.com/api/v3/contacts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://sms.xcobean.com/api/v3/contacts",
        "per_page": 25,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}

二、 CONTACTS API

1. 总概

Xcobean SMS Contacts API 可帮助您管理由唯一随机 ID 标识的联系人。 使用此 ID,您可以创建、查看、更新或删除联系人。 此 API 用作客户特定联系人的集合,允许您对它们进行分组并分配自定义值,您稍后可以在发送 SMS 模板消息时使用这些值。

Contacts API 使用 HTTP 动词和 RESTful 端点结构以及用作 API 授权的访问密钥。 使用 UTF-8 编码和 URL 编码值将请求和响应有效负载格式化为 JSON。

2. Create a contact

url: https://sms.xcobean.com/api/v3/contacts/{group_id}/store
method: POST
parameter:
group_id: 645e38f3e7e9d
content:

{
    "phone": "25420342277",
    "first_name": "Tana",
    "last_name": "River"
}

return:

{
    "status": "success",
    "message": "Contact was successfully added",
    "data": {
        "customer_id": 7,
        "group_id": 6,
        "phone": 25420317778,
        "first_name": "Tana",
        "last_name": "River",
        "uid": "645e5a0e3833b",
        "status": "subscribe",
        "updated_at": "2023-05-12T15:23:58.000000Z",
        "created_at": "2023-05-12T15:23:58.000000Z",
        "id": 3
    }
}

3. View a contact

url: https://sms.xcobean.com/api/v3/contacts/{{group_id}}/search/{{uid}}
method: POST
return:

{
    "status": "success",
    "message": null,
    "data": {
        "uid": "645e5a0e3833b",
        "phone": "25420641216",
        "first_name": "Taita",
        "last_name": "Taveta"
    }
}

4. Update a contact

url: https://sms.xcobean.com/api/v3/contacts/{group_id}/update/{uid}
method: PATCH
content:

{
    "phone":"25420343715"
}

return:

{
    "status": "success",
    "message": "Contact was successfully updated",
    "data": {
        "id": 3,
        "uid": "645e5a0e3833b",
        "customer_id": 7,
        "group_id": 6,
        "phone": 25420558565,
        "status": "subscribe",
        "first_name": "Garissa",
        "last_name": "Wajir",
        "email": null,
        "username": null,
        "company": null,
        "address": null,
        "birth_date": null,
        "anniversary_date": null,
        "created_at": "2023-05-12T15:23:58.000000Z",
        "updated_at": "2023-05-12T15:23:58.000000Z"
    }
}

5. View all contacts in group

url: https://sms.xcobean.com/api/v3/contacts/{group_id}/all
method: POST
return:

{
    "status": "success",
    "message": null,
    "data": {
        "current_page": 1,
        "data": [
            {
                "uid": "645e59a786720",
                "phone": 25420552298,
                "first_name": "Mandera",
                "last_name": "Marsabit"
            },
            {
                "uid": "645e59b3716d6",
                "phone": 25420550493,
                "first_name": "Isiolo",
                "last_name": "Meru"
            },
            {
                "uid": "645e5a0e3833b",
                "phone": 25420344037,
                "first_name": "Tharaka",
                "last_name": "Nithi"
            }
        ],
        "first_page_url": "https://sms.xcobean.com/api/v3/contacts/645e56be3c6d2/all?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://sms.xcobean.com/api/v3/contacts/645e56be3c6d2/all?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://sms.xcobean.com/api/v3/contacts/645e56be3c6d2/all?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://sms.xcobean.com/api/v3/contacts/645e56be3c6d2/all",
        "per_page": 25,
        "prev_page_url": null,
        "to": 3,
        "total": 3
    }
}

6. Delete a contact

url: https://sms.xcobean.com/api/v3/contacts/{group_id}/delete/{uid}
method: delete
return:

{
    "status": "success",
    "message": "Contact was successfully deleted",
    "data": null
}

三、 SMS API

1. 总概

Xcobean SMS SMS API 允许您通过 REST API 向世界上任何国家/地区发送和接收 SMS 消息。 每条消息都由一个唯一的随机 ID 标识,以便用户始终可以使用给定的端点检查消息的状态。

2. Send outbound SMS

url: https://sms.xcobean.com/api/v3/sms/send
method: POST
content:

{
    "recipient": "25420829085",
    "sender_id": "[Test]",
    "type": "plain",
    "message": "Dear user"
}

return:

{
    "status": "error",
    "message": "No sending server available for your subscribed plan"
}

3. View an SMS

url: https://sms.xcobean.com/api/v3/sms/{uid}
method: GET
parameter:
uid: 645e5a0e3833b
content:

{
    "recipient": "25420550331",
    "sender_id": "[Test]",
    "type": "plain",
    "message": "Dear user"
}

return:

{
    "status": "error",
    "message": "No query results for model [App\\Models\\Reports] 645e59b3716d6"
}

4. View all messages

url: https://sms.xcobean.com/api/v3/sms/
method: GET
return:

{
    "status": "success",
    "message": null,
    "data": {
        "current_page": 1,
        "data": [],
        "first_page_url": "https://sms.xcobean.com/api/v3/sms?page=1",
        "from": null,
        "last_page": 1,
        "last_page_url": "https://sms.xcobean.com/api/v3/sms?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://sms.xcobean.com/api/v3/sms?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://sms.xcobean.com/api/v3/sms",
        "per_page": 25,
        "prev_page_url": null,
        "to": null,
        "total": 0
    }
}

四、 WHATSAPP API

1. 总概

Xcobean SMS SMS API 允许您通过 REST API 向世界上任何国家/地区发送和接收 SMS 消息。 每条消息都由一个唯一的随机 ID 标识,以便用户始终可以使用给定的端点检查消息的状态。
API Endpoint

2. Send outbound SMS

url: https://sms.xcobean.com/api/v3/sms/send
method: POST
content:

{
    "recipient": "25420555259",
    "sender_id": "YourName",
    "type": "whatsapp",
    "message": "This is a test message"
}

return:

{
    "status": "error",
    "message": "No sending server available for your subscribed plan"
}

3. View an SMS

url: https://sms.xcobean.com/api/v3/sms/{uid}
method: GET
parameter:
uid: 645e5a0e3833b
return:

{
    "status": "success",
    "message": null,
    "data": {
        "current_page": 1,
        "data": [],
        "first_page_url": "https://sms.xcobean.com/api/v3/sms?page=1",
        "from": null,
        "last_page": 1,
        "last_page_url": "https://sms.xcobean.com/api/v3/sms?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://sms.xcobean.com/api/v3/sms?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://sms.xcobean.com/api/v3/sms",
        "per_page": 25,
        "prev_page_url": null,
        "to": null,
        "total": 0
    }
}

4. View all messages

url: https://sms.xcobean.com/api/v3/sms/
method: GET
parameter:
uid: 645e5a0e3833b
return:

{
    "status": "success",
    "message": null,
    "data": {
        "current_page": 1,
        "data": [],
        "first_page_url": "https://sms.xcobean.com/api/v3/sms?page=1",
        "from": null,
        "last_page": 1,
        "last_page_url": "https://sms.xcobean.com/api/v3/sms?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://sms.xcobean.com/api/v3/sms?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://sms.xcobean.com/api/v3/sms",
        "per_page": 25,
        "prev_page_url": null,
        "to": null,
        "total": 0
    }
}

总结:
总共黏贴了四个章节的指南,
1.contact groups api
2.contacts api
3.sms api
4.whatsapp api

《登高》是一首鼓励程序员小白的古诗,全诗如下:

飞流直下三千尺,
疑似骑鹤腾空泄。
千峰万壑路不定,
迷花倚石忽已暝。
熊咆龙吟殷岩泉,
栗深林兮惊层巅。
云横秦岭家何在?
雪拥蓝关马不前。

这首诗借用了自然界的壮丽景色,鼓励程序员小白要像登高者一样,勇往直前,迎接新的挑战。即使面对千峰万壑,也要坚定地迈出脚步,探索前行的道路。同时,诗中也表达了对困难的正视和克服困难的勇气。

古人在写诗时常常以自然景观来寄托情感和寓意,这种表达方式也可以激励现代程序员面对技术挑战时的勇气和决心。
SMS短信API 名 称:SMS API 版 本:V1.1(built 2004.02.29) 功 能:通过短信网关发送手机短信 作 者:Starboy (starboy@xdevelop.net) Longlybug (sales@xdevelop.net) 网 址:http://www.xdevelop.net 简介   SMS API(for java)是一个通过网关发送手机短信的JAVA开发包,提供了方便的开发应用接口,JAVA开发者可利用它轻松的定制出各类短信应用平台,如:企业OA应用中的短信提醒、网站中的定单短信提醒、交友平台的手机短信互动等等。短信应用开发者无需再去关心网关协议,或者研究与手机间的通信指令等。使用本API,开发者无需关心其它细节,只需调用API,即可实现手机短信应用中最常用的短信发送功能。 功能特点 支持移动和联通手机,自动识别 SMS API实现了短信即时发送和定时发送。支持联通和移动手机,发送时无需关心目标手机运营商,自动识别移动和联通。整体成功率约90%左右。   发送性能优异稳定 API使用的网关服务器拥有多线程发送能力,每秒可同时处理数十个客户端的并发请求。   平台无关性 客户端适用于任何可运行JAVA的平台,包括:Windows、LINUX、UNIX、MAC等。 不像DLL接口,只能运行于WINDOWS平台。 对于WEB应用来说,本API可运行于任何J2EE规范的应用服务器。   接口简洁易用 短信API的接口非常简单,封装了与短信服务器网关的通讯,调用者无需关心底层通讯细节。   无硬件设备要求 只要能上INTERNET网即可使用本API发送短信,无需购买任何手机硬件、短信MODEM、短信卡、数据线等。   费用低廉,接入简单 只需缴纳一定量的接入费并签定短信内容保证书,即可立刻拥有自己的短信平台,每条短信的发送费用为0.1元,可根据需要随时充值。   适合用户 本平台适合那些对短信功能要求比较单一,以及每日发送量不大的各类应用。 安装部署   SMS API开发包由两个文件组成,一个是smsclient.jar:API程序文件,另一个是sms.ini:程序配置文件。   对于JAVA桌面应用程序,需将smsclient.jar加入classpath,并将sms.ini放于classpath所在的一个目录   对于JSP WEB应用程序,可将smsclient.jar放入对应WEB应用的WEB-INF/lib/目录下,并将sms.ini放于WEB-INF/classes/根目录下。   关于API的使用及sms.ini的配置,请参看doc目录下的API使用说明和API文档。   试用版的功能限制   试用版只能发5条短信! 购买联系   欢迎您注册本软件,请与双子星工作室的程先生联系:   EMAIL:sales@xdevelop.net   OICQ:33450   网址:http://www.xdevelop.net   TEL:13510015276   如果您有任何疑问,也请通过以上方式同我们联系,谢谢您的支持!
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值