Documentation - Contacts


  1. Creating a new contact
  2. Updating an existing contact
  3. Adding a phone number to an existing contact
  4. Removing a phone number from an existing contact
  5. Getting a contacts information
  6. Searching contacts

Contacts - Adding a phone number to an existing contact

You can add a new phone number to an existing contact using the contact API
Below is some sample requests and response. For complete API documentation on adding a phone number to an existing contact please refer to the Swagger (Open API Specification) documentations here: SMS Gateway API Definition


API Request

Request Endpoint
Endpoint: https://smsgateway.me/api/v4/contact/{id}/phone-number/{phoneNumber}
Method: PUT
Request Parameters
Name Location Required Description
Authorization header true Your API token found on the settings page
id path true The id of the contact the API should update
phone number path true The id of the phone number the api should add

Request Example

A put request with the contact and phone number in the path

{
  "PUT": "https://smsgateway.me/api/v4/contact/2/phone-number/+447712345678"
}

Response Examples

Successful Response

A successful response will bring back the updated contact object

Response Code: 200

{
  "id": 2,
  "name": "John Doe",
  "phone_numbers": [
    "+447791064782",
    "+447791064782",
    "+447712345678"
  ]
}

Error Response

When a request can not be processed

Response Code: 40x | 500

{
  "status": "fail",
  "message": "Could not process request",
  "data": {
    "exception": "Error message"
  }
}

SDK Examples

You can use our Swagger generated PHP SDK to help integrate with our service. If you wish to use SMS Gateway Me with a different platform you may generate your own client using the swagger file.

Installation Instructions: PHP SMS Gateway SDK
Swagger Definition: SMS Gateway API Definition


Request Example

<?php

require 'vendor/autoload.php';

use SMSGatewayMe\Client\ApiClient;
use SMSGatewayMe\Client\Configuration;
use SMSGatewayMe\Client\Api\ContactApi;

// Configure client
$config = Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'your-token-here');
$apiClient = new ApiClient($config);

// Create contact client
$contactClient = new ContactApi($apiClient);

// Add number to contact
$contact = $contactClient->addPhoneNumber(12590982, '07791064787');
print_r($contact);

Successful Response

SMSGatewayMe\Client\Model\Contact Object
(
    [id:protected] => 12590982
    [name:protected] => Johnathon Doe
    [phoneNumbers:protected] => Array
        (
            [0] => 07791064785
            [1] => 07791064786
            [2] => 07791064787
        )
)