开发人员文档 WhatsApp

WhatsApp 文档

本文档专门用于发送和接收 WhatsApp 消息。

点击此处了解更多信息了解我们的 WhatsApp 集成提供的所有功能。

在 SMSmobileAPI，我们努力使我们的 API 尽可能与任何架构或平台兼容。
无论您使用的是 REST、SOAP、cURL 还是各种编程语言（如 Python、JavaScript、PHP 等），我们的 API 都旨在无缝集成到您的项目中。

我们还拥有适用于电子商务解决方案和软件的可立即使用的插件。点击此处了解详情.

API 休息

cURL

JavaScript

Python

Node.js

红宝石

WSDL

发送 WhatsApp

端点
参数
例子

重新发送消息

端点
参数
例子

同步

端点
参数
例子

检索消息

端点
参数
例子

验证

API 密钥
OAuth2

发送 WhatsApp API

此 API 端点用于发送 WhatsApp 消息。

端点：

GET POST https://api.smsmobileapi.com/sendsms

参数：

范围	描述
apikey	必需的您的唯一 API 密钥。
recipients	必需的收件人的电话号码（该号码必须在 WhatsApp 上可用）。输入以国家代码（不带“+”和“00”）开头的电话号码，然后直接输入其余部分。例子： 191728660
message	必需的要发送的消息（可以有多行）。
waonly	必需的必须具有价值是的 → 需要指定只发送一条 WhatsApp 消息。
url_media	您要通过 WhatsApp 发送的媒体文件的直接 URL。必须以 https:// 并指向一个有效的 PDF, 文档或者图像文件。该文件必须无需身份验证即可公开访问。支持的格式：文件： pdf、xml、doc、docx、odt、rtf、txt、tex、xls、xlsx、csv、ods、ppt、pptx、odp、zip、rar、7z、tar、gz 图片： jpg, jpeg, png
url_media_shorted	如果值为是的，并且设置了[pdf_with_image=yes]，则PDF的下载链接会通过短网址显示。
pdf_with_image	如果值为是的，将显示 PDF 的图像预览来伴随消息（仅当文件为 PDF 时）。
encrypt_message	是的 = 收件人阅读时，邮件将被加密。收件人需要输入唯一的密钥来解密消息。了解有关消息加密的更多信息

无媒体示例：


        GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&waonly=yes&recipients=191728660&message=Hello%20World

媒体示例：


        GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&waonly=yes&recipients=191728660&message=Hello%20World&url_media=https://smsmobileapi.com/logo.png

WhatsApp 中的文本格式：

斜体： 使用下划线 → _text_
大胆的： 使用星号 → *文本*
删除线： 使用波浪符号 → ~text~
等宽字体： 使用反引号 → ```text```

例如：_Hello_ world，你今天好吗？来自```SMSMobileAPI```

重新发送未发送的 WhatsApp 消息

此 API 端点用于重新发送未发送的消息（仅当消息具有错误状态时）

端点：

得到邮政 https://api.smsmobileapi.com/resendwa/

范围：

范围	描述
guid	必需的要重新发送的消息的 GUID。

例子：


        获取 https://api.smsmobileapi.com/resendwa/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE

同步检索消息

此 API 端点用于发送同步和检索 WhatsApp 消息的请求。
此步骤是强制性的，必须在调用检索消息的端点之前执行。

警告： 仅对于消息检索功能才严格要求同步。不要启动同步来发送消息。

端点：

GET https://api.smsmobileapi.com/getwa/synchronisation/

范围：

范围	描述
apikey (required)	必需的您拥有或将收到的 API 密钥。

例子：


        GET https://api.smsmobileapi.com/getwa/synchronisation/?apikey=YOUR_API_KEY

回复：



{


 “错误”：“0”，

   “消息”：“同步”，

  “expire_at”：“2025-03-11 12:27:00”，

  “expire_at_unix”：“1741692420”，


 

}

检索 WhatsApp 消息

此 API 端点用于检索收到的 WhatsApp 消息。

端点：

GET https://api.smsmobileapi.com/getwa

范围：

范围	描述
apikey	必需的您拥有或将收到的 API 密钥。
before	将时间戳作为参数传递，并显示该时间戳以下的记录。
date	（yyyy-mm-dd）根据日期获取所有记录。
message_type	留空即可查看全部（文本和音频消息）使用 `文本` 仅查看短信使用 `声音的` 仅查看转换为文本的音频消息

例子：


        GET https://api.smsmobileapi.com/getwa/?apikey=YOUR_API_KEY

回复：



{


  “日期”：“2025-03-11”，

  “小时”：“12:27:00”，

  “时间戳”：“1741692420”，

  “号码”：“19176728660”，

  “联系人”：“Smsmobileapi”，

  "message": "你能告诉我什么时候能收到我的订单吗？",

  “guid”：“652fcfc0-12a8-46f5-b5ba-9391135b8b4c”，

  
  “更多的”： {

    "自动回复": "1",

    "transfert_to_email": "1",

    “chatgpt_reply”：“1”

	
  },


  “chatgpt”：{

    “prompt_tokens”：“900”，

    “完成令牌”：“10”，

    “total_tokens”：“910”，

    “总代币成本”：“0.182”

	 “response”：“您的订单 #576 将于明天发货。”

	
  }

    
  
}

验证

SMSMobile API 支持两种身份验证方法：使用简单的 API 密钥或带有客户端 ID 和客户端密钥的 OAuth2 协议。

1. API 密钥认证

要通过我们的 API 发送或检索 WhatsApp 消息，需要使用 API 密钥进行身份验证。这可确保安全且授权地访问消息服务。只需在请求中包含您的 API 密钥即可进行身份验证，并开始无缝发送消息。

2. OAuth2 身份验证

OAuth2提供了一种更安全、更可扩展的身份验证方法。
您需要使用客户端 ID 和客户端密钥来获取访问令牌，然后使用授权標軸。

client_id 和 client_secret 在您的仪表板中可用。

获取访问令牌

要获取访问令牌，请使用您的客户端 ID 和客户端密钥向令牌端点发送 POST 请求。


curl -X POST https://api.smsmobileapi.com/oauth2/token \

-H "Content-Type: application/x-www-form-urlencoded" \

-d "grant_type=client_credentials" \

-d "client_id=1ab0ex4b4c1ef2c800690d" \

-d "client_secret=3ed108a93d0414074b94364290b6a7348475e93a0567005"

使用访问令牌：

获得访问令牌后，将其包含在授权您的 API 请求标头：


curl -X POST https://api.smsmobileapi.com/sendsms?waonly=yes \

-H "Authorization: Bearer abc123xyz456" \

-H "Content-Type: application/x-www-form-urlencoded" \

-d "recipients=+1234567890" \

-d "message=Hello"

Which Method Should You Use?

- Use API Key Authentication for quick and straightforward integrations.

- Use OAuth2 Authentication for enhanced security and scalability in your integrations.

发送 WhatsApp 消息

WSDL 网址

https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl

参数：

- recipients: 收件人的手机号码。

- message: 要发送的消息。

- apikey: 您拥有或将收到的 API 密钥。

- waonly: 必须具有价值是的 -> 需要指定只应发送一条 WhatsApp 消息。

示例


                require_once "lib/nusoap.php";

                

                $client = new nusoap_client("https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl", true);

                $error  = $client->getError();

                

                $result = $client->call("sendSms", array("waonly" =>"yes","recipients" =>$_GET['recipients'],"message" =>$_GET['message'],"apikey" =>$_GET['apikey']));

                

                print_r($result);

发送 WhatsApp

基本 cURL 命令

您可以使用以下 cURL 命令通过 SMSmobileAPI 发送 WhatsApp 消息：


        curl -X POST https://api.smsmobileapi.com/sendsms/?waonly=yes \

        -d "recipients=PHONE_NUMBER" \

        -d "message=YOUR_MESSAGE" \

        -d "apikey=YOUR_API_KEY"

PHP 中的 cURL 示例

如果您使用 PHP，则可以使用 cURL 发送 WhatsApp 消息的方法如下：


        <?php

        

        $url = 'https://api.smsmobileapi.com/sendsms/?waonly=yes';

        $data = array(

            'recipients' => 'PHONE_NUMBER',

            'message' => 'YOUR_MESSAGE',

            'apikey' => 'YOUR_API_KEY'


        );

        

        $options = array(

            CURLOPT_URL => $url,

            CURLOPT_POST => true,

            CURLOPT_POSTFIELDS => http_build_query($data),

            CURLOPT_RETURNTRANSFER => true,

        );

        

        $ch = curl_init();

        curl_setopt_array($ch, $options);

        $response = curl_exec($ch);

        curl_close($ch);

        

        echo $response;

        

        ?>

此 PHP 示例演示如何使用 cURL 向 SMSmobileAPI 发送 POST 请求，并将必要的参数作为关联数组传递。

发送 WhatsApp

使用我们的官方 Python 模块： https://smsmobileapi.com/python/
或者使用手动方式...

使用 `requests` 库

`requests` 库是 Python 的一个流行且简单的 HTTP 库。以下是如何使用其通过 SMSmobileAPI 发送 WhatsApp 消息：


        import requests



        url = "https://api.smsmobileapi.com/sendsms/waonly=yes"



        payload = {

            "recipients": "PHONE_NUMBER",

            "message": "YOUR_MESSAGE",

            "apikey": "YOUR_API_KEY"

        }



        response = requests.post(url, data=payload)



        print(response.text)

此示例演示了向 SMSmobileAPI 发送简单的 POST 请求，将 WhatsApp 消息发送到特定的电话号码。

使用 `http.client` 库

`http.client` 库包含在 Python 的标准库中，也可以用于与你的 API 进行交互：


        import http.client

        import urllib.parse



        conn = http.client.HTTPSConnection("api.smsmobileapi.com")



        params = urllib.parse.urlencode({

            "recipients": "PHONE_NUMBER",

            "message": "YOUR_MESSAGE",

            "apikey": "YOUR_API_KEY"

        })



        headers = { "Content-type": "application/x-www-form-urlencoded" }



        conn.request("POST", "/sendsms/?waonly=yes", params, headers)

        response = conn.getresponse()

        data = response.read()



        print(data.decode("utf-8"))

        conn.close()

此示例展示了如何使用 `http.client` 库向 API 发送 POST 请求。参数经过 URL 编码，并使用适当的标头发送。

发送 WhatsApp

使用 `fetch` API

`fetch` API 是一种使用 JavaScript 发出 HTTP 请求的现代且通用的方法。以下是如何使用该方法通过 SMSmobileAPI 发送 WhatsApp 消息：


        const url = "https://api.smsmobileapi.com/sendsms/?waonly=yes";



        const data = {

            recipients: "PHONE_NUMBER",

            message: "YOUR_MESSAGE",

            apikey: "YOUR_API_KEY"

        };



        fetch(url, {

            method: "POST",

            headers: {

                "Content-Type": "application/x-www-form-urlencoded"

            },

            body: new URLSearchParams(data)

        })

        .then(response => response.text())

        .then(result => console.log(result))

        .catch(error => console.error("Error:", error));

此示例演示如何使用大多数现代浏览器支持的“fetch”API 发送 POST 请求。

使用 XMLHttpRequest

如果需要支持旧版浏览器，可以使用 `XMLHttpRequest` 对象：


        const xhr = new XMLHttpRequest();

        const url = "https://api.smsmobileapi.com/sendsms/?waonly=yes";



        const data = "recipients=PHONE_NUMBER&message=YOUR_MESSAGE&apikey=YOUR_API_KEY";



        xhr.open("POST", url, true);

        xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");



        xhr.onreadystatechange = function() {

            if (xhr.readyState === 4 && xhr.status === 200) {

                console.log(xhr.responseText);

            }

        };



        xhr.send(data);

此示例显示如何使用“XMLHttpRequest”发送POST请求，以兼容可能不支持“fetch”的老版本浏览器。

发送 WhatsApp

使用 `axios` 库

`axios` 库是 Node.js 的一个流行 HTTP 客户端。以下是使用它通过 SMSmobileAPI 发送 WhatsApp 消息的方法：


        const axios = require('axios');



        const url = 'https://api.smsmobileapi.com/sendsms/?waonly=yes';

        const data = {

            recipients: 'PHONE_NUMBER',

            message: 'YOUR_MESSAGE',

            apikey: 'YOUR_API_KEY'

        };



        axios.post(url, data)

        .then(response => {

            console.log(response.data);

        })

        .catch(error => {

            console.error('Error:', error);

        });

此示例演示如何使用 Node.js 中的“axios”发送 POST 请求与 SMSmobileAPI 进行交互。

发送 WhatsApp

使用 `Net::HTTP` 库

您可以使用 Ruby 中的 `Net::HTTP` 库通过 SMSmobileAPI 发送 WhatsApp 消息：


        require 'net/http'

        require 'uri'



        uri = URI.parse("https://api.smsmobileapi.com/sendsms/?waonly=yes")

        request = Net::HTTP::Post.new(uri)

        request.set_form_data(

            "recipients" => "PHONE_NUMBER",

            "message" => "YOUR_MESSAGE",

            "apikey" => "YOUR_API_KEY"

        )



        req_options = {

            use_ssl: uri.scheme == "https",

        }



        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|

            http.request(request)

        end



        puts response.body

此示例演示如何使用 Ruby 中的“Net::HTTP”向 SMSmobileAPI 发送 POST 请求。

也可以同时发送 WhatsApp 消息和短信.

如果您有任何疑问、建议或需要帮助，我们的团队将随时为您提供帮助。
欢迎联系我们 api@smsmobileapi.com

SMS 功能

WhatsApp 功能

通用插件

网上商店插件

API 和开发者文档

工具和变更日志

WhatsApp 文档

发送 WhatsApp

重新发送消息

同步

检索消息

验证

发送 WhatsApp API

端点：

参数：

无媒体示例：

媒体示例：

WhatsApp 中的文本格式：

重新发送未发送的 WhatsApp 消息

端点：

范围：

例子：

同步检索消息

端点：

范围：

例子：

回复 ：

检索 WhatsApp 消息

端点：

范围：

例子：

回复 ：

验证

1. API 密钥认证

2. OAuth2 身份验证

获取访问令牌

使用访问令牌：

Which Method Should You Use?

发送 WhatsApp 消息

WSDL 网址

参数：

示例

发送 WhatsApp

基本 cURL 命令

PHP 中的 cURL 示例

发送 WhatsApp

使用 `requests` 库

使用 `http.client` 库

发送 WhatsApp

使用 `fetch` API

使用 XMLHttpRequest

发送 WhatsApp

使用 `axios` 库

发送 WhatsApp

使用 `Net::HTTP` 库

回复：

回复：