Phonebook API

All endpoints require HTTP basic authorization header with Messente API username and password.

You can find the API username and password under your Account API Settings.

Returns all blacklisted phone numbers

GET https://api.messente.com/v1/phonebook/blacklist

Successful Response

HTTP 200 - An object containing a list of blacklisted phone numbers
Property Type Info
phoneNumbers array

Array of unique phone numbers

Element type: string
Unique items

Error Responses

HTTP 401 - Unauthorized
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Adds a phone number to the blacklist

POST https://api.messente.com/v1/phonebook/blacklist

Request Body

Body is required. Phone number to be blacklisted
Property Type Info
phoneNumberrequired string

Phone number in e.164 format

Successful Response

HTTP 204 - Phone number added to the blacklist
No response body

Error Responses

HTTP 400 - Invalid phone number provided
HTTP 401 - Unauthorized
HTTP 409 - Phone number already blacklisted
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Checks if a phone number is blacklisted

GET https://api.messente.com/v1/phonebook/blacklist/{phone}

Request Parameters

Name Location Info
phonerequired The parameter is part of the URL path
A phone number
Type: string

Successful Response

HTTP 204 - Phone number is in the blacklist
No response body

Error Responses

HTTP 400 - Invalid phone number provided
HTTP 401 - Unauthorized
HTTP 404 - Phone number is not in the blacklist
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Deletes a phone number from the blacklist

DELETE https://api.messente.com/v1/phonebook/blacklist/{phone}

Request Parameters

Name Location Info
phonerequired The parameter is part of the URL path
A phone number
Type: string

Successful Response

HTTP 204 - Phone number deleted from the blacklist
No response body

Error Responses

HTTP 400 - Invalid phone number provided
HTTP 401 - Unauthorized
HTTP 404 - Phone number is not in the blacklist
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Lists a contact

GET https://api.messente.com/v1/phonebook/contacts/{phone}

Request Parameters

Name Location Info
phonerequired The parameter is part of the URL path
A phone number
Type: string

Successful Response

HTTP 200 - An object containing a contact object
Property Type Info
contact object

A container for response fields of a contact

Property Type Info
phoneNumber string

Phone number in e.164 format
email string

The email of the contact
firstName string

The first name of the contact
lastName string

The last name of the contact
company string

The company of the contact
title string

The title of the contact
custom string

The first custom field
custom2 string

The second custom field
custom3 string

The third custom field
custom4 string

The fourth custom field
scheduledDeletionDate string

The date in ISO 8601 format, YYYY-MM-DD, on which the contact is going to be deleted because it has not belonged to a group for 30 days

Format: date

Error Responses

HTTP 400 - Invalid phone number provided
HTTP 401 - Unauthorized
HTTP 404 - Contact missing
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Deletes a contact

DELETE https://api.messente.com/v1/phonebook/contacts/{phone}

Request Parameters

Name Location Info
phonerequired The parameter is part of the URL path
A phone number
Type: string

Successful Response

HTTP 204 - Contact deleted
No response body

Error Responses

HTTP 400 - Invalid phone number provided
HTTP 401 - Unauthorized
HTTP 404 - Contact missing
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Updates a contact

PATCH https://api.messente.com/v1/phonebook/contacts/{phone}

Request Parameters

Name Location Info
phonerequired The parameter is part of the URL path
A phone number
Type: string

Request Body

Body is required
Property Type Info
email string

The email of the contact
firstName string

The first name of the contact
lastName string

The last name of the contact
company string

The company of the contact
title string

The title of the contact
custom string

The first custom field
custom2 string

The second custom field
custom3 string

The third custom field
custom4 string

The fourth custom field

Successful Response

HTTP 200 - An object containing a contact object
Property Type Info
contact object

A container for response fields of a contact

Property Type Info
phoneNumber string

Phone number in e.164 format
email string

The email of the contact
firstName string

The first name of the contact
lastName string

The last name of the contact
company string

The company of the contact
title string

The title of the contact
custom string

The first custom field
custom2 string

The second custom field
custom3 string

The third custom field
custom4 string

The fourth custom field
scheduledDeletionDate string

The date in ISO 8601 format, YYYY-MM-DD, on which the contact is going to be deleted because it has not belonged to a group for 30 days

Format: date

Error Responses

HTTP 400 - Invalid phone number or empty patch body or unknown fields provided
HTTP 401 - Unauthorized
HTTP 404 - Contact missing
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Lists groups of a contact

GET https://api.messente.com/v1/phonebook/contacts/{phone}/groups

Request Parameters

Name Location Info
phonerequired The parameter is part of the URL path
A phone number
Type: string

Successful Response

HTTP 200 - An object containing a list of group objects
Property Type Info
groups array

An array of groups

A container for fields of a group

Property Type Info
idrequired string

Id string in UUID format
namerequired string

The name of the group
createdOn string

When the group was created

Format: %Y-%m-%dT%H:%M:%S.%fZ
contactsCountrequired integer

The count of contacts in the group
Unique items

Error Responses

HTTP 400 - Invalid phone number provided
HTTP 401 - Unauthorized
HTTP 404 - Contact missing
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Returns all contacts

GET https://api.messente.com/v1/phonebook/contacts

Request Parameters

Name Location Info
groupIds The parameter is part of the URL query string
Optional one or many group id strings in UUID format. For example: "/contacts?groupIds=group_id_one&groupIds=group_id_two"
Type: array
Element type: string

Successful Response

HTTP 200 - An object containing a list of contact objects
Property Type Info
contacts array

An array of contacts

A container for response fields of a contact

Property Type Info
phoneNumber string

Phone number in e.164 format
email string

The email of the contact
firstName string

The first name of the contact
lastName string

The last name of the contact
company string

The company of the contact
title string

The title of the contact
custom string

The first custom field
custom2 string

The second custom field
custom3 string

The third custom field
custom4 string

The fourth custom field
scheduledDeletionDate string

The date in ISO 8601 format, YYYY-MM-DD, on which the contact is going to be deleted because it has not belonged to a group for 30 days

Format: date
Unique items

Error Responses

HTTP 400 - Invalid "groupIds" parameters provided
HTTP 401 - Unauthorized
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Creates a new contact

POST https://api.messente.com/v1/phonebook/contacts

Request Body

Body is required
Property Type Info
phoneNumberrequired string

Phone number in e.164 format
email string

The email of the contact
firstName string

The first name of the contact
lastName string

The last name of the contact
company string

The company of the contact
title string

The title of the contact
custom string

The first custom field
custom2 string

The second custom field
custom3 string

The third custom field
custom4 string

The fourth custom field

Successful Response

HTTP 201 - An object containing a contact object
Property Type Info
contact object

A container for response fields of a contact

Property Type Info
phoneNumber string

Phone number in e.164 format
email string

The email of the contact
firstName string

The first name of the contact
lastName string

The last name of the contact
company string

The company of the contact
title string

The title of the contact
custom string

The first custom field
custom2 string

The second custom field
custom3 string

The third custom field
custom4 string

The fourth custom field
scheduledDeletionDate string

The date in ISO 8601 format, YYYY-MM-DD, on which the contact is going to be deleted because it has not belonged to a group for 30 days

Format: date

Error Responses

HTTP 400 - Invalid phone number provided
HTTP 401 - Unauthorized
HTTP 409 - Contact with phone already created
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Lists a group

GET https://api.messente.com/v1/phonebook/groups/{groupId}

Request Parameters

Name Location Info
groupIdrequired The parameter is part of the URL path
String in UUID format
Type: string

Successful Response

HTTP 200 - An object containing a group object
Property Type Info
group object

A container for fields of a group

Property Type Info
idrequired string

Id string in UUID format
namerequired string

The name of the group
createdOn string

When the group was created

Format: %Y-%m-%dT%H:%M:%S.%fZ
contactsCountrequired integer

The count of contacts in the group

Error Responses

HTTP 401 - Unauthorized
HTTP 404 - Missing group
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Deletes a group

DELETE https://api.messente.com/v1/phonebook/groups/{groupId}

Request Parameters

Name Location Info
groupIdrequired The parameter is part of the URL path
String in UUID format
Type: string

Successful Response

HTTP 204 - Group deleted
No response body

Error Responses

HTTP 401 - Unauthorized
HTTP 404 - Group missing
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Updates a group with the provided name

PUT https://api.messente.com/v1/phonebook/groups/{groupId}

Request Parameters

Name Location Info
groupIdrequired The parameter is part of the URL path
String in UUID format
Type: string

Request Body

Body is required
Property Type Info
namerequired string

The name of the group

Minimum length: 1

Successful Response

HTTP 200 - An object containing a group object
Property Type Info
group object

A container for fields of a group

Property Type Info
idrequired string

Id string in UUID format
namerequired string

The name of the group
createdOn string

When the group was created

Format: %Y-%m-%dT%H:%M:%S.%fZ
contactsCountrequired integer

The count of contacts in the group

Error Responses

HTTP 400 - Name is invalid string or shorter than length 1
HTTP 401 - Unauthorized
HTTP 404 - Group missing
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Adds a contact to a group

POST https://api.messente.com/v1/phonebook/groups/{groupId}/contacts/{phone}

Request Parameters

Name Location Info
groupIdrequired The parameter is part of the URL path
String in UUID format
Type: string
phonerequired The parameter is part of the URL path
A phone number
Type: string

Successful Response

HTTP 201 - An empty object
A response body containing empty JSON object

Error Responses

HTTP 400 - Invalid phone number provided
HTTP 401 - Unauthorized
HTTP 404 - Contact or group is missing
HTTP 409 - Contact already added to group
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Removes a contact from a group

DELETE https://api.messente.com/v1/phonebook/groups/{groupId}/contacts/{phone}

Request Parameters

Name Location Info
groupIdrequired The parameter is part of the URL path
String in UUID format
Type: string
phonerequired The parameter is part of the URL path
A phone number
Type: string

Successful Response

HTTP 204 - Contact removed from group
No response body

Error Responses

HTTP 400 - Invalid phone number provided
HTTP 401 - Unauthorized
HTTP 404 - Contact or group is missing or contact is missing from group
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Returns all groups

GET https://api.messente.com/v1/phonebook/groups

Successful Response

HTTP 200 - An object containing a list of group objects
Property Type Info
groups array

An array of groups

A container for fields of a group

Property Type Info
idrequired string

Id string in UUID format
namerequired string

The name of the group
createdOn string

When the group was created

Format: %Y-%m-%dT%H:%M:%S.%fZ
contactsCountrequired integer

The count of contacts in the group
Unique items

Error Responses

HTTP 401 - Unauthorized
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error

Creates a new group with the provided name

POST https://api.messente.com/v1/phonebook/groups

Request Body

Body is required
Property Type Info
namerequired string

The name of the group

Minimum length: 1

Successful Response

HTTP 201 - An object containing a group object
Property Type Info
group object

A container for fields of a group

Property Type Info
idrequired string

Id string in UUID format
namerequired string

The name of the group
createdOn string

When the group was created

Format: %Y-%m-%dT%H:%M:%S.%fZ
contactsCountrequired integer

The count of contacts in the group

Error Responses

HTTP 400 - Name is invalid string or shorter than length 1
HTTP 401 - Unauthorized
HTTP 500 - General error
Property Type Info
errorsrequired array

An array of errors

A container for Phonebook API error

Property Type Info
titlerequired string

Textual value which corresponds to an error code

Possible values:
  • Invalid data
  • Unauthorized
  • Missing resource
  • Conflict
  • Client error
  • General error
detailrequired string

Free form more detailed description of the error
coderequired string

Matches the following error title. This field is a constant

  • 201 - Invalid data
  • 202 - Unauthorized
  • 203 - Missing resource
  • 204 - Conflict
  • 244 - Client error
  • 205 - General error