osiomagency/osiosms-php

用于与OsioSMS API交互的PHP包。

维护者

详细信息

github.com/osiomagency/osiosms-php

源代码

问题

安装: 4

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 0

分支: 0

开放性问题: 0

1.0 2024-08-12 15:54 UTC

Requires

MIT 9c5115dca44e62b83fefaea15f002b80b83607cf

  • Nicolas BAUD <nicolas.baud.woop@osiom.fr>

This package is auto-updated.

Last update: 2024-09-27 16:33:45 UTC

README

描述

OsioSMS API PHP包是一个综合性的库，旨在方便与OsioSMS平台交互。此包允许开发人员无缝地将各种OsioSMS服务集成到他们的PHP应用程序中，包括联系人管理、短信发送、语音消息、MMS、WhatsApp消息、Viber、OTP和配置文件管理。无论您是管理联系人、发送消息还是检查账户余额，此包都提供了一个统一且易于使用的界面，满足您所有的OsioSMS API需求。

目录

基本用法

安装

通过Composer安装包

composer require yourname/osiosms-contacts

初始化

要开始使用Contacts API，通过提供您的OsioSMS API令牌来初始化Contacts类

use OsioSms\OsioSms;

$osiosms = new OsioSms('your_api_token');

以下是markdown格式的## 联系人部分

联系人

Contacts类提供了在OsioSMS平台内管理联系人的方法。您可以在特定的联系人组中创建、查看、更新、删除和列出联系人。

创建联系人

要在特定组中创建新联系人，请使用create方法

$response = $osiosms->contacts()->create('group_id', '31612345678', [
    'FIRST_NAME' => 'John',
    'LAST_NAME' => 'Doe',
]);

print_r($response);

查看联系人

要查看现有联系人的详细信息，请使用view方法

$response = $osiosms->contacts()->view('group_id', 'contact_uid');

print_r($response);

更新联系人

要更新现有联系人，请使用update方法

$response = $osiosms->contacts()->update('group_id', 'contact_uid', '31612345678', [
    'FIRST_NAME' => 'Jane',
    'LAST_NAME' => 'Doe',
]);

print_r($response);

删除联系人

要删除现有联系人，请使用delete方法

$response = $osiosms->contacts()->delete('group_id', 'contact_uid');

print_r($response);

查看组内所有联系人

要查看特定组内的所有联系人，请使用viewAll方法

$response = $osiosms->contacts()->viewAll('group_id');

print_r($response);

群组

Groups类提供了在OsioSMS平台内管理联系人组的方法。您可以在联系人组中创建、查看、更新、删除和列出联系人。

创建群组

要创建新的联系人组，请使用create方法

$response = $osiosms->groups()->create('Group Name');

print_r($response);

查看群组

要查看现有联系人组的详细信息，请使用view方法

$response = $osiosms->groups()->view('group_id');

print_r($response);

更新群组

要更新现有联系人组的名称，请使用update方法

$response = $osiosms->groups()->update('group_id', 'New Group Name');

print_r($response);

删除群组

要删除现有联系人组，请使用delete方法

$response = $osiosms->groups()->delete('group_id');

print_r($response);

查看所有群组

要查看所有联系人组，请使用viewAll方法

$response = $osiosms->groups()->viewAll();

print_r($response);

MMS

Mms类提供了使用OsioSMS平台发送和管理MMS消息的方法。您可以发送MMS消息、查看特定MMS的详细信息，以及列出所有MMS消息。

发送MMS

要发送MMS消息，请使用send方法

$response = $osiosms->mms()->send(
    '+33612345678', // Recipient's phone number
    'YourName',    // Sender ID
    'https://example.com/150.jpg', // URL of the media to be sent
    'This is a test MMS message', // Optional message body
    '2021-12-20 07:00' // Optional scheduled time in RFC3339 format
);

print_r($response);

查看MMS

要查看特定MMS消息的详细信息，请使用view方法

$response = $osiosms->mms()->view('mms_uid');

print_r($response);

查看所有MMS消息

要查看所有MMS消息，请使用viewAll方法

$response = $osiosms->mms()->viewAll();

print_r($response);

短信

Sms类提供了使用OsioSMS平台发送和管理SMS消息的方法。您可以发送单个SMS消息、运行SMS活动，以及查看特定SMS消息或活动的详细信息。

发送短信

要发送SMS消息，请使用send方法

$response = $osiosms->sms()->send(
    '+33612345678',  // Recipient's phone number
    'YourName',     // Sender ID
    'plain',        // Message type (e.g., 'plain' for regular SMS)
    'This is a test SMS message', // Message body
    '2021-12-20 07:00', // Optional scheduled time in RFC3339 format
    'dlt_template_id'   // Optional DLT template ID
);

print_r($response);

发送短信活动

要将短信活动发送到联系人列表，请使用sendCampaign方法

$response = $osiosms->sms()->sendCampaign(
    'contact_list_id', // ID of the contact list
    'YourName',        // Sender ID
    'plain',           // Message type (e.g., 'plain' for regular SMS)
    'This is a campaign SMS message', // Message body
    '2021-12-20 07:00', // Optional scheduled time in RFC3339 format
    'dlt_template_id'   // Optional DLT template ID
);

print_r($response);

查看短信

要查看特定SMS消息的详细信息，请使用view方法

$response = $osiosms->sms()->view('sms_uid');

print_r($response);

查看所有短信消息

要查看所有短信消息，请使用viewAll方法

$response = $osiosms->sms()->viewAll();

print_r($response);

查看特定短信活动

要查看特定短信活动的详细信息，请使用viewCampaign方法

$response = $osiosms->sms()->viewCampaign('campaign_uid');

print_r($response);

语音

Voice类提供了使用OsioSMS平台发送和管理语音消息的方法。您可以发送语音消息、查看特定语音消息的详细信息以及列出所有语音消息。

发送语音消息

要发送语音消息，请使用send方法

$response = $osiosms->voice()->send(
    '+33612345678',  // Recipient's phone number
    'YourName',     // Sender ID
    'en-gb',        // Language code (e.g., 'en-gb' for British English)
    'female',       // Gender ('male' or 'female')
    'This is a test voice message', // Message to be spoken
    '2021-12-20 07:00' // Optional scheduled time in RFC3339 format
);

print_r($response);

查看语音消息

要查看特定语音消息的详细信息，请使用view方法

$response = $osiosms->voice()->view('voice_uid');

print_r($response);

查看所有语音消息

要查看所有语音消息，请使用viewAll方法

$response = $osiosms->voice()->viewAll();

print_r($response);

OTP

Otp类提供了使用OsioSMS平台发送和管理一次性密码（OTP）消息的方法。您可以发送OTP消息、查看特定OTP消息的详细信息以及列出所有OTP消息。

发送OTP消息

要发送OTP消息，请使用send方法

$response = $osiosms->otp()->send(
    '31612345678',  // Recipient's phone number
    'YourName',     // Sender ID
    'Your OTP code is 123456', // OTP message content
    '2021-12-20 07:00' // Optional scheduled time in RFC3339 format
);

print_r($response);

查看OTP消息

要查看特定OTP消息的详细信息，请使用view方法

$response = $osiosms->otp()->view('otp_uid');

print_r($response);

查看所有OTP消息

要查看所有OTP消息，请使用viewAll方法

$response = $osiosms->otp()->viewAll();

print_r($response);

WhatsApp

Whatsapp类提供了使用OsioSMS平台发送和管理WhatsApp消息的方法。您可以发送WhatsApp消息、查看特定WhatsApp消息的详细信息以及列出所有WhatsApp消息。

发送WhatsApp消息

要发送WhatsApp消息，请使用send方法

$response = $osiosms->whatsapp()->send(
    '+33612345678',  // Recipient's phone number
    'YourName',     // Sender ID
    'This is a test WhatsApp message', // Message content
    'https://example.com/150.jpg', // Optional media URL for attachment
    '2021-12-20 07:00' // Optional scheduled time in RFC3339 format
);

print_r($response);

查看WhatsApp消息

要查看特定WhatsApp消息的详细信息，请使用view方法

$response = $osiosms->whatsapp()->view('whatsapp_uid');

print_r($response);

查看所有WhatsApp消息

要查看所有WhatsApp消息，请使用viewAll方法

$response = $osiosms->whatsapp()->viewAll();

print_r($response);

Viber

ViberApi类提供了使用OsioSMS平台发送和管理Viber消息的方法。您可以发送Viber消息、查看特定Viber消息的详细信息以及列出所有Viber消息。

发送Viber消息

要发送Viber消息，请使用send方法

$response = $osiosms->viber()->send(
    '+33612345678',  // Recipient's phone number
    'YourName',     // Sender ID
    'This is a test Viber message', // Message content
    'https://via.placeholder.com/150.jpg', // Optional media URL for attachment
    '2021-12-20 07:00' // Optional scheduled time in RFC3339 format
);

print_r($response);

查看Viber消息

要查看特定Viber消息的详细信息，请使用view方法

$response = $osiosms->viber()->view('viber_uid');

print_r($response);

查看所有Viber消息

要查看所有Viber消息，请使用viewAll方法

$response = $osiosms->viber()->viewAll();

print_r($response);

配置文件

Profile类提供了使用OsioSMS平台检索账户信息的方法，包括您的剩余短信余额和配置文件详细信息。

查看短信余额

要检查您的剩余短信余额，请使用viewBalance方法

$response = $osiosms->profile()->viewBalance();

print_r($response);

查看配置文件信息

要查看您的配置文件详细信息，请使用viewProfile方法

$response = $osiosms->profile()->viewProfile();

print_r($response);

响应处理

所有方法都返回一个包含OsioSMS API响应数据的数组。如果请求成功，则status将为success，并且data将包含联系详情或相关信息。在出现错误的情况下，status将为error，并且message将提供易于理解的错误描述。