> For the complete documentation index, see [llms.txt](https://layerlabs.gitbook.io/phone-verification-system/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://layerlabs.gitbook.io/phone-verification-system/community-created-custom-dev-kits/bulksms-custom-dev-kit.md).

# BulkSMS Custom Dev Kit

This page explains the necessary steps to integrate BulkSMS API gateway into Layer's PVS Module using the Custom Dev Kit.

### Please Remember <a href="#please_remember" id="please_remember"></a>

* `$phone` variable will be automatically supplied, and contains the customer's phone number
* `$code` variable will be automatically supplied, and contains a 4 digit code

### The Steps <a href="#the_steps" id="the_steps"></a>

* Download the file below
* Replace the authorization header - go to <https://www.bulksms.com/account/#!/advanced-settings/api-tokens> and generate a new token and paste the basic auth here
* Overwrite the file customdevkit.php in the module's directory
* Go to Setup → Addon Modules in WHMCS Admin
* Click on Configure for Phone Verification System
* Change the Gateway Provider to CustomDevKit
* Save

### File <a href="#example" id="example"></a>

The file below shows BulkSMS integrated using the Custom Dev Kit.

```php
<?php
#  Layer's Phone Verification System for WHMCS (Custom Dev Kit Example)
#
#  This file contains an example to help you integrate any SMS provider API's gateway. 
#  The example below shows how to integrate BulkSMS's API into Layer's PVS Module.
#  Please be advised that we do not provide support for custom integrations. 
#
#  $phone will be automatically supplied, and contains the customer's phone number
#  $code will be automatically supplied, and contains a 4 digit code
#
#  Example is provided below
#provide the content of the SMS message - remember to include the $code variable in your message, as that is the code to be sent to the customer
$body="Hello! The verification code is: ".$code.". Thank you for verifying your account!";
#build the API request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.bulksms.com/v1/messages');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Authorization: Basic MkE3QTFBNzFFNEY0NDUxNDlGMjM2MjVEODFGQkEwNDktMDItNjpzIWEqSVM1Wk04aGpzRzZrNElBaCpDXXXXXXXXXX==',   // go to https://www.bulksms.com/account/#!/advanced-settings/api-tokens and generate a new token and paste the basic auth here                          
));
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'to' => $phone,
            'body' => $body,
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);
#log the attempt to help troubleshoot
logModuleCall("myrskpvs","customdevkit-sms",$ch,$response);
?>
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://layerlabs.gitbook.io/phone-verification-system/community-created-custom-dev-kits/bulksms-custom-dev-kit.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
