Skip to content

ContactsApi.md

Latest commit

 

History

History
499 lines (344 loc) · 13.9 KB

ContactsApi.md

File metadata and controls

499 lines (344 loc) · 13.9 KB

Messente\Api\ContactsApi

All URIs are relative to https://api.messente.com/v1, except if the operation defines another base path.

Method HTTP request Description
addContactToGroup() POST /phonebook/groups/{groupId}/contacts/{phone} Adds a contact to a group
createContact() POST /phonebook/contacts Creates a new contact
deleteContact() DELETE /phonebook/contacts/{phone} Deletes a contact
fetchContact() GET /phonebook/contacts/{phone} Lists a contact
fetchContactGroups() GET /phonebook/contacts/{phone}/groups Lists groups of a contact
fetchContacts() GET /phonebook/contacts Returns all contacts
removeContactFromGroup() DELETE /phonebook/groups/{groupId}/contacts/{phone} Removes a contact from a group
updateContact() PATCH /phonebook/contacts/{phone} Updates a contact

addContactToGroup()

addContactToGroup($groupId, $phone): object

Adds a contact to a group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Messente\Api\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Messente\Api\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$groupId = 5792a02a-e5c2-422b-a0a0-0ae65d814663; // string | String in UUID format
$phone = +37251000000; // string | A phone number

try {
    $result = $apiInstance->addContactToGroup($groupId, $phone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->addContactToGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
groupId string String in UUID format
phone string A phone number

Return type

object

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createContact()

createContact($contactFields): \Messente\Api\Model\ContactEnvelope

Creates a new contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Messente\Api\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Messente\Api\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$contactFields = {"phoneNumber":"+37251000000","email":"anyone@messente.com","firstName":"Any","lastName":"One","company":"Messente","title":"Sir","custom":"Any custom","custom2":"Any custom two","custom3":"Any custom three","custom4":"Any custom four"}; // \Messente\Api\Model\ContactFields

try {
    $result = $apiInstance->createContact($contactFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->createContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
contactFields \Messente\Api\Model\ContactFields

Return type

\Messente\Api\Model\ContactEnvelope

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteContact()

deleteContact($phone)

Deletes a contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Messente\Api\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Messente\Api\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$phone = +37251000000; // string | A phone number

try {
    $apiInstance->deleteContact($phone);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->deleteContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
phone string A phone number

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetchContact()

fetchContact($phone): \Messente\Api\Model\ContactEnvelope

Lists a contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Messente\Api\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Messente\Api\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$phone = +37251000000; // string | A phone number

try {
    $result = $apiInstance->fetchContact($phone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->fetchContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
phone string A phone number

Return type

\Messente\Api\Model\ContactEnvelope

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetchContactGroups()

fetchContactGroups($phone): \Messente\Api\Model\GroupListEnvelope

Lists groups of a contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Messente\Api\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Messente\Api\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$phone = +37251000000; // string | A phone number

try {
    $result = $apiInstance->fetchContactGroups($phone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->fetchContactGroups: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
phone string A phone number

Return type

\Messente\Api\Model\GroupListEnvelope

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetchContacts()

fetchContacts($groupIds): \Messente\Api\Model\ContactListEnvelope

Returns all contacts

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Messente\Api\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Messente\Api\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$groupIds = ["5792a02a-e5c2-422b-a0a0-0ae65d814663","4792a02a-e5c2-422b-a0a0-0ae65d814662"]; // string[] | Optional one or many group id strings in UUID format. For example: \"/contacts?groupIds=group_id_one&groupIds=group_id_two\"

try {
    $result = $apiInstance->fetchContacts($groupIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->fetchContacts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
groupIds string[] Optional one or many group id strings in UUID format. For example: &quot;/contacts?groupIds=group_id_one&groupIds=group_id_two&quot; [optional]

Return type

\Messente\Api\Model\ContactListEnvelope

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeContactFromGroup()

removeContactFromGroup($groupId, $phone)

Removes a contact from a group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Messente\Api\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Messente\Api\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$groupId = 5792a02a-e5c2-422b-a0a0-0ae65d814663; // string | String in UUID format
$phone = +37251000000; // string | A phone number

try {
    $apiInstance->removeContactFromGroup($groupId, $phone);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->removeContactFromGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
groupId string String in UUID format
phone string A phone number

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateContact()

updateContact($phone, $contactUpdateFields): \Messente\Api\Model\ContactEnvelope

Updates a contact

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Messente\Api\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Messente\Api\Api\ContactsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$phone = +37251000000; // string | A phone number
$contactUpdateFields = {"email":"anyone@messente.com","firstName":"Any","lastName":"One","company":"Messente","title":"Sir","custom":"Any custom","custom2":"Any custom two","custom3":"Any custom three","custom4":"Any custom four"}; // \Messente\Api\Model\ContactUpdateFields

try {
    $result = $apiInstance->updateContact($phone, $contactUpdateFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->updateContact: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
phone string A phone number
contactUpdateFields \Messente\Api\Model\ContactUpdateFields

Return type

\Messente\Api\Model\ContactEnvelope

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]