Identity Verification and Message Engagement Registration

Wrapper for various Identity Verification services and Message Engagement Platforms

Baixar a especificação OpenAPI

Identities

APIs relating to working with Identities

Operações disponíveis

Retrieve all of the identities associated with your account.

List identities

gethttps://api.nexmo.com/v1/messaging-engagement/identities

Respostas
Tipo de conteúdo
application/json

List of brands that are associated with an account

page_size
integer
exemplo10

Items per page

page
integer
Mín.1
exemplo2

Page Offset

total_pages
integer
Mín.1
exemplo100

Number of pages in the entire result set

total_items
integer
exemplo100

Number of items in the entire result set

_embedded
object
brands
array
entity_type
string
exemploPUBLIC_PROFIT
Deve ser uma das seguintes opções:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exemploVonage
company_name
string
exemploVonage
ein
string
exemplo20-1111111
alt_business_id_type
string
exemploDUNS
alt_business_id
string
exemplo150483782
phone
string
exemplo+15556660001
street
string
exemplo23 Main Street
city
string
exemploHolmdel
state
string
exemploNJ
postal_code
string
exemplo07733
country
string
exemploUS
email
string
exemplodevrel@vonage.com
stock_symbol
string
exemploVG
stock_exchange
string
exemploNASDAQ
website
string
exemplohttps://vonage.com
brand_relationship
string
exemploKEY_ACCOUNT
Deve ser uma das seguintes opções:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exemploTECHNOLOGY
identity_id
string
exemploBLQKOPK

Identity ID associated with a number

created_date
string
exemplo2020-01-02 05:12:14
last_updated
string
exemplo2020-02-02 14:12:00
_links
object
self
object
href
string
exemplohttps://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK
engagements
object
href
string
exemplohttps://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK

Exemplo Resposta

{
   "page_size": 10,
   "page": 2,
   "total_pages": 100,
   "total_items": 100,
   "_embedded": {
      "brands": [
         {
            "entity_type": "PUBLIC_PROFIT",
            "display_name": "Vonage",
            "company_name": "Vonage",
            "ein": "20-1111111",
            "alt_business_id_type": "DUNS",
            "alt_business_id": "150483782",
            "phone": "+15556660001",
            "street": "23 Main Street",
            "city": "Holmdel",
            "state": "NJ",
            "postal_code": "07733",
            "country": "US",
            "email": "devrel@vonage.com",
            "stock_symbol": "VG",
            "stock_exchange": "NASDAQ",
            "website": "https://vonage.com",
            "brand_relationship": "KEY_ACCOUNT",
            "vertical": "TECHNOLOGY",
            "identity_id": "BLQKOPK",
            "created_date": "2020-01-02 05:12:14",
            "last_updated": "2020-02-02 14:12:00",
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK"
               },
               "engagements": {
                  "href": "https://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK"
               }
            }
         }
      ]
   }
}

Create a new identity for your account

Create a new identity for your account. Most accounts will be created immediately, and you can move on to qualifying a new engagement for the identity. Some brands may require additional vetting. In such cases, please move on to the vetting API endpoints before attempting to create an engagement.

Please note the entity_type field, as that field value will help determine which fields are required.

posthttps://api.nexmo.com/v1/messaging-engagement/identities

Corpo da solicitação
Tipo de conteúdo
application/json

Um dos
entity_type
string
Obrigatório
exemploPUBLIC_PROFIT
Deve ser uma das seguintes opções:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
Obrigatório
exemploVonage
company_name
string
exemploVonage
ein
string
exemplo20-1111111
alt_business_id_type
string
exemploDUNS
alt_business_id
string
exemplo150483782
phone
string
Obrigatório
exemplo+15556660001
street
string
exemplo23 Main Street
city
string
exemploHolmdel
state
string
exemploNJ
postal_code
string
exemplo07733
country
string
Obrigatório
exemploUS
email
string
Obrigatório
exemplodevrel@vonage.com
stock_symbol
string
exemploVG
stock_exchange
string
exemploNASDAQ
website
string
exemplohttps://vonage.com
brand_relationship
string
Obrigatório
exemploKEY_ACCOUNT
Deve ser uma das seguintes opções:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exemploTECHNOLOGY

Exemplo Solicitação

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "company_name": "Vonage",
   "ein": "20-1111111",
   "alt_business_id_type": "DUNS",
   "alt_business_id": "150483782",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "website": "https://vonage.com",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY"
}
{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "phone": "+15556660001",
   "country": "US",
   "email": "devrel@vonage.com",
   "brand_relationship": "KEY_ACCOUNT"
}

Respostas
Tipo de conteúdo
application/json

Return a single identity

entity_type
string
exemploPUBLIC_PROFIT
Deve ser uma das seguintes opções:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exemploVonage
company_name
string
exemploVonage
ein
string
exemplo20-1111111
alt_business_id_type
string
exemploDUNS
alt_business_id
string
exemplo150483782
phone
string
exemplo+15556660001
street
string
exemplo23 Main Street
city
string
exemploHolmdel
state
string
exemploNJ
postal_code
string
exemplo07733
country
string
exemploUS
email
string
exemplodevrel@vonage.com
stock_symbol
string
exemploVG
stock_exchange
string
exemploNASDAQ
website
string
exemplohttps://vonage.com
brand_relationship
string
exemploKEY_ACCOUNT
Deve ser uma das seguintes opções:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exemploTECHNOLOGY
identity_id
string
exemploBLQKOPK

Identity ID associated with a number

created_date
string
exemplo2020-01-02 05:12:14
last_updated
string
exemplo2020-02-02 14:12:00
_links
object
self
object
href
string
exemplo[ "https://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK", "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c" ]
engagements
object
href
string
exemplohttps://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK

Exemplo Resposta

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "company_name": "Vonage",
   "ein": "20-1111111",
   "alt_business_id_type": "DUNS",
   "alt_business_id": "150483782",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "website": "https://vonage.com",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY",
   "identity_id": "BLQKOPK",
   "created_date": "2020-01-02 05:12:14",
   "last_updated": "2020-02-02 14:12:00",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c"
      },
      "engagements": {
         "href": "https://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK"
      }
   }
}

Retrieve a specific identity

Get an identity

gethttps://api.nexmo.com/v1/messaging-engagement/identities/:identity_id

Caminho Parâmetros

identity_id
string
Obrigatório
exemploBLQKOPK

Identity ID associated with a number

Respostas
Tipo de conteúdo
application/json

Return a single identity

entity_type
string
exemploPUBLIC_PROFIT
Deve ser uma das seguintes opções:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exemploVonage
company_name
string
exemploVonage
ein
string
exemplo20-1111111
alt_business_id_type
string
exemploDUNS
alt_business_id
string
exemplo150483782
phone
string
exemplo+15556660001
street
string
exemplo23 Main Street
city
string
exemploHolmdel
state
string
exemploNJ
postal_code
string
exemplo07733
country
string
exemploUS
email
string
exemplodevrel@vonage.com
stock_symbol
string
exemploVG
stock_exchange
string
exemploNASDAQ
website
string
exemplohttps://vonage.com
brand_relationship
string
exemploKEY_ACCOUNT
Deve ser uma das seguintes opções:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exemploTECHNOLOGY
identity_id
string
exemploBLQKOPK

Identity ID associated with a number

created_date
string
exemplo2020-01-02 05:12:14
last_updated
string
exemplo2020-02-02 14:12:00
_links
object
self
object
href
string
exemplo[ "https://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK", "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c" ]
engagements
object
href
string
exemplohttps://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK

Exemplo Resposta

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "company_name": "Vonage",
   "ein": "20-1111111",
   "alt_business_id_type": "DUNS",
   "alt_business_id": "150483782",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "website": "https://vonage.com",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY",
   "identity_id": "BLQKOPK",
   "created_date": "2020-01-02 05:12:14",
   "last_updated": "2020-02-02 14:12:00",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c"
      },
      "engagements": {
         "href": "https://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK"
      }
   }
}

Partially update a specific identity

Partial update of an identity

patchhttps://api.nexmo.com/v1/messaging-engagement/identities/:identity_id

Caminho Parâmetros

identity_id
string
Obrigatório
exemploBLQKOPK

Identity ID associated with a number

Corpo da solicitação
Tipo de conteúdo
application/json

entity_type
string
exemploPUBLIC_PROFIT
Deve ser uma das seguintes opções:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exemploVonage
website
string
exemplohttps://vonage.com
phone
string
exemplo+15556660001
street
string
exemplo23 Main Street
city
string
exemploHolmdel
state
string
exemploNJ
postal_code
string
exemplo07733
country
string
exemploUS
email
string
exemplodevrel@vonage.com
stock_symbol
string
exemploVG
stock_exchange
string
exemploNASDAQ
brand_relationship
string
exemploKEY_ACCOUNT
vertical
string
exemploTECHNOLOGY

Exemplo Solicitação

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "website": "https://vonage.com",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY"
}
{}

Respostas
Tipo de conteúdo
application/json

Return a single identity

entity_type
string
exemploPUBLIC_PROFIT
Deve ser uma das seguintes opções:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exemploVonage
company_name
string
exemploVonage
ein
string
exemplo20-1111111
alt_business_id_type
string
exemploDUNS
alt_business_id
string
exemplo150483782
phone
string
exemplo+15556660001
street
string
exemplo23 Main Street
city
string
exemploHolmdel
state
string
exemploNJ
postal_code
string
exemplo07733
country
string
exemploUS
email
string
exemplodevrel@vonage.com
stock_symbol
string
exemploVG
stock_exchange
string
exemploNASDAQ
website
string
exemplohttps://vonage.com
brand_relationship
string
exemploKEY_ACCOUNT
Deve ser uma das seguintes opções:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exemploTECHNOLOGY
identity_id
string
exemploBLQKOPK

Identity ID associated with a number

created_date
string
exemplo2020-01-02 05:12:14
last_updated
string
exemplo2020-02-02 14:12:00
_links
object
self
object
href
string
exemplo[ "https://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK", "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c" ]
engagements
object
href
string
exemplohttps://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK

Exemplo Resposta

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "company_name": "Vonage",
   "ein": "20-1111111",
   "alt_business_id_type": "DUNS",
   "alt_business_id": "150483782",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "website": "https://vonage.com",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY",
   "identity_id": "BLQKOPK",
   "created_date": "2020-01-02 05:12:14",
   "last_updated": "2020-02-02 14:12:00",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c"
      },
      "engagements": {
         "href": "https://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK"
      }
   }
}

Update a specific identity

Update an identity

puthttps://api.nexmo.com/v1/messaging-engagement/identities/:identity_id

Caminho Parâmetros

identity_id
string
Obrigatório
exemploBLQKOPK

Identity ID associated with a number

Corpo da solicitação
Tipo de conteúdo
application/json

entity_type
string
exemploPUBLIC_PROFIT
Deve ser uma das seguintes opções:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exemploVonage
website
string
exemplohttps://vonage.com
phone
string
exemplo+15556660001
street
string
exemplo23 Main Street
city
string
exemploHolmdel
state
string
exemploNJ
postal_code
string
exemplo07733
country
string
exemploUS
email
string
exemplodevrel@vonage.com
stock_symbol
string
exemploVG
stock_exchange
string
exemploNASDAQ
brand_relationship
string
exemploKEY_ACCOUNT
vertical
string
exemploTECHNOLOGY

Exemplo Solicitação

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "website": "https://vonage.com",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY"
}
{}

Respostas
Tipo de conteúdo
application/json

Return a single identity

entity_type
string
exemploPUBLIC_PROFIT
Deve ser uma das seguintes opções:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
exemploVonage
company_name
string
exemploVonage
ein
string
exemplo20-1111111
alt_business_id_type
string
exemploDUNS
alt_business_id
string
exemplo150483782
phone
string
exemplo+15556660001
street
string
exemplo23 Main Street
city
string
exemploHolmdel
state
string
exemploNJ
postal_code
string
exemplo07733
country
string
exemploUS
email
string
exemplodevrel@vonage.com
stock_symbol
string
exemploVG
stock_exchange
string
exemploNASDAQ
website
string
exemplohttps://vonage.com
brand_relationship
string
exemploKEY_ACCOUNT
Deve ser uma das seguintes opções:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
exemploTECHNOLOGY
identity_id
string
exemploBLQKOPK

Identity ID associated with a number

created_date
string
exemplo2020-01-02 05:12:14
last_updated
string
exemplo2020-02-02 14:12:00
_links
object
self
object
href
string
exemplo[ "https://api.nexmo.com/v1/messaging-engagement/identities/BLQKOPK", "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c" ]
engagements
object
href
string
exemplohttps://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK

Exemplo Resposta

{
   "entity_type": "PUBLIC_PROFIT",
   "display_name": "Vonage",
   "company_name": "Vonage",
   "ein": "20-1111111",
   "alt_business_id_type": "DUNS",
   "alt_business_id": "150483782",
   "phone": "+15556660001",
   "street": "23 Main Street",
   "city": "Holmdel",
   "state": "NJ",
   "postal_code": "07733",
   "country": "US",
   "email": "devrel@vonage.com",
   "stock_symbol": "VG",
   "stock_exchange": "NASDAQ",
   "website": "https://vonage.com",
   "brand_relationship": "KEY_ACCOUNT",
   "vertical": "TECHNOLOGY",
   "identity_id": "BLQKOPK",
   "created_date": "2020-01-02 05:12:14",
   "last_updated": "2020-02-02 14:12:00",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/identities/5782db87-a867-4ccd-a0b5-1b7203cc438c"
      },
      "engagements": {
         "href": "https://api.nexmo.com/v1/messaging-envagement/engagements/?identity_id=BLQKOPK"
      }
   }
}

Remove a specific identity from your account

Delete an identity

deletehttps://api.nexmo.com/v1/messaging-engagement/identities/:identity_id

Caminho Parâmetros

identity_id
string
Obrigatório
exemploBLQKOPK

Identity ID associated with a number

Respostas

No content

Engagements

APIs relating to working with Engagements

Operações disponíveis

Retrieve all of the engagements

List engagements

gethttps://api.nexmo.com/v1/messaging-engagement/engagements

Respostas
Tipo de conteúdo
application/json

List of engagements that are associated with an identity

page_size
integer
exemplo10

Items per page

page
integer
Mín.1
exemplo2

Page Offset

total_pages
integer
Mín.1
exemplo100

Number of pages in the entire result set

total_items
integer
exemplo100

Number of items in the entire result set

_embedded
object
brands
array
identity_id
string
exemploBLQKOPK

Identity ID associated with a number

vertical
string
exemploTECHNOLOGY
use_case
string
exemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplostring
description
string
exemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exemplotrue
direct_lending
boolean
exemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exemploSample Message
sample_two
string
exemploAdditional Sample Message
sample_three
string
exemploAdditional Sample Message
sample_four
string
exemploAdditional Sample Message
message_flow
string
exemplostring
help_message
string
exemplostring
affiliate_marketing
boolean
exemplotrue
engagement_id
string
exemploC1DEB879

ID associated with a specific engagement

created_date
string
last_updated
string
_links
object
self
object
href
string
numbers
object
href
string

Exemplo Resposta

{
   "page_size": 10,
   "page": 2,
   "total_pages": 100,
   "total_items": 100,
   "_embedded": {
      "brands": [
         {
            "identity_id": "BLQKOPK",
            "vertical": "TECHNOLOGY",
            "use_case": "ACCOUNT_NOTIFICATION",
            "sub_use_cases": [
               "2FA",
               "SECURITY_ALERT"
            ],
            "reseller_id": "string",
            "description": "User notifications",
            "embedded_link": false,
            "embedded_phone": false,
            "number_pool": false,
            "age_gated": true,
            "direct_lending": true,
            "subscriber_optin": false,
            "subscriber_optout": false,
            "subscriber_help": false,
            "sample_one": "Sample Message",
            "sample_two": "Additional Sample Message",
            "sample_three": "Additional Sample Message",
            "sample_four": "Additional Sample Message",
            "message_flow": "string",
            "help_message": "string",
            "affiliate_marketing": true,
            "engagement_id": "C1DEB879",
            "created_date": "string",
            "last_updated": "string",
            "_links": {
               "self": {
                  "href": "string"
               },
               "numbers": {
                  "href": "string"
               }
            }
         }
      ]
   }
}

Add a new engagement to an identity

Create Engagement

posthttps://api.nexmo.com/v1/messaging-engagement/engagements

Corpo da solicitação
Tipo de conteúdo
application/json

identity_id
string
Obrigatório
exemploBLQKOPK

Identity ID associated with a number

vertical
string
Obrigatório
exemploTECHNOLOGY
use_case
string
Obrigatório
exemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplostring
description
string
Obrigatório
exemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exemplotrue
direct_lending
boolean
exemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exemploSample Message
sample_two
string
exemploAdditional Sample Message
sample_three
string
exemploAdditional Sample Message
sample_four
string
exemploAdditional Sample Message
message_flow
string
exemplostring
help_message
string
exemplostring
affiliate_marketing
boolean
exemplotrue

Exemplo Solicitação

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true
}
{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "description": "User notifications"
}

Respostas
Tipo de conteúdo
application/json

Return a single engagement

identity_id
string
exemploBLQKOPK

Identity ID associated with a number

vertical
string
exemploTECHNOLOGY
use_case
string
exemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplostring
description
string
exemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exemplotrue
direct_lending
boolean
exemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exemploSample Message
sample_two
string
exemploAdditional Sample Message
sample_three
string
exemploAdditional Sample Message
sample_four
string
exemploAdditional Sample Message
message_flow
string
exemplostring
help_message
string
exemplostring
affiliate_marketing
boolean
exemplotrue
engagement_id
string
exemploC1DEB879

ID associated with a specific engagement

created_date
string
last_updated
string
_links
object
self
object
href
string
exemplo/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab
numbers
object
href
string

Exemplo Resposta

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true,
   "engagement_id": "C1DEB879",
   "created_date": "string",
   "last_updated": "string",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab"
      },
      "numbers": {
         "href": "string"
      }
   }
}

Retrieve a specific engagement

Get an engagement

gethttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id

Caminho Parâmetros

engagement_id
string
Obrigatório
exemploC1DEB879

ID associated with a specific engagement

Respostas
Tipo de conteúdo
application/json

Return a single engagement

identity_id
string
exemploBLQKOPK

Identity ID associated with a number

vertical
string
exemploTECHNOLOGY
use_case
string
exemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplostring
description
string
exemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exemplotrue
direct_lending
boolean
exemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exemploSample Message
sample_two
string
exemploAdditional Sample Message
sample_three
string
exemploAdditional Sample Message
sample_four
string
exemploAdditional Sample Message
message_flow
string
exemplostring
help_message
string
exemplostring
affiliate_marketing
boolean
exemplotrue
engagement_id
string
exemploC1DEB879

ID associated with a specific engagement

created_date
string
last_updated
string
_links
object
self
object
href
string
exemplo/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab
numbers
object
href
string

Exemplo Resposta

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true,
   "engagement_id": "C1DEB879",
   "created_date": "string",
   "last_updated": "string",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab"
      },
      "numbers": {
         "href": "string"
      }
   }
}

Partially update a specific engagement

Partial update of an engagement

patchhttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id

Caminho Parâmetros

engagement_id
string
Obrigatório
exemploC1DEB879

ID associated with a specific engagement

Corpo da solicitação
Tipo de conteúdo
application/json

identity_id
string
exemploBLQKOPK

Identity ID associated with a number

vertical
string
exemploTECHNOLOGY
use_case
string
exemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplostring
description
string
exemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exemplotrue
direct_lending
boolean
exemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exemploSample Message
sample_two
string
exemploAdditional Sample Message
sample_three
string
exemploAdditional Sample Message
sample_four
string
exemploAdditional Sample Message
message_flow
string
exemplostring
help_message
string
exemplostring
affiliate_marketing
boolean
exemplotrue

Exemplo Solicitação

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true
}
{}

Respostas
Tipo de conteúdo
application/json

Return a single engagement

identity_id
string
exemploBLQKOPK

Identity ID associated with a number

vertical
string
exemploTECHNOLOGY
use_case
string
exemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplostring
description
string
exemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exemplotrue
direct_lending
boolean
exemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exemploSample Message
sample_two
string
exemploAdditional Sample Message
sample_three
string
exemploAdditional Sample Message
sample_four
string
exemploAdditional Sample Message
message_flow
string
exemplostring
help_message
string
exemplostring
affiliate_marketing
boolean
exemplotrue
engagement_id
string
exemploC1DEB879

ID associated with a specific engagement

created_date
string
last_updated
string
_links
object
self
object
href
string
exemplo/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab
numbers
object
href
string

Exemplo Resposta

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true,
   "engagement_id": "C1DEB879",
   "created_date": "string",
   "last_updated": "string",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab"
      },
      "numbers": {
         "href": "string"
      }
   }
}

Update a specific engagement

Update an engagement

puthttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id

Caminho Parâmetros

engagement_id
string
Obrigatório
exemploC1DEB879

ID associated with a specific engagement

Corpo da solicitação
Tipo de conteúdo
application/json

identity_id
string
exemploBLQKOPK

Identity ID associated with a number

vertical
string
exemploTECHNOLOGY
use_case
string
exemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplostring
description
string
exemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exemplotrue
direct_lending
boolean
exemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exemploSample Message
sample_two
string
exemploAdditional Sample Message
sample_three
string
exemploAdditional Sample Message
sample_four
string
exemploAdditional Sample Message
message_flow
string
exemplostring
help_message
string
exemplostring
affiliate_marketing
boolean
exemplotrue

Exemplo Solicitação

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true
}
{}

Respostas
Tipo de conteúdo
application/json

Return a single engagement

identity_id
string
exemploBLQKOPK

Identity ID associated with a number

vertical
string
exemploTECHNOLOGY
use_case
string
exemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
exemplostring
description
string
exemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
exemplotrue
direct_lending
boolean
exemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
exemploSample Message
sample_two
string
exemploAdditional Sample Message
sample_three
string
exemploAdditional Sample Message
sample_four
string
exemploAdditional Sample Message
message_flow
string
exemplostring
help_message
string
exemplostring
affiliate_marketing
boolean
exemplotrue
engagement_id
string
exemploC1DEB879

ID associated with a specific engagement

created_date
string
last_updated
string
_links
object
self
object
href
string
exemplo/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab
numbers
object
href
string

Exemplo Resposta

{
   "identity_id": "BLQKOPK",
   "vertical": "TECHNOLOGY",
   "use_case": "ACCOUNT_NOTIFICATION",
   "sub_use_cases": [
      "2FA",
      "SECURITY_ALERT"
   ],
   "reseller_id": "string",
   "description": "User notifications",
   "embedded_link": false,
   "embedded_phone": false,
   "number_pool": false,
   "age_gated": true,
   "direct_lending": true,
   "subscriber_optin": false,
   "subscriber_optout": false,
   "subscriber_help": false,
   "sample_one": "Sample Message",
   "sample_two": "Additional Sample Message",
   "sample_three": "Additional Sample Message",
   "sample_four": "Additional Sample Message",
   "message_flow": "string",
   "help_message": "string",
   "affiliate_marketing": true,
   "engagement_id": "C1DEB879",
   "created_date": "string",
   "last_updated": "string",
   "_links": {
      "self": {
         "href": "/v1/messaging-engagement/engagements/57b3a89e-c9fa-4860-aec2-ad7f51539dab"
      },
      "numbers": {
         "href": "string"
      }
   }
}

Stop a specific engagement on an identity

Stop an engagement

deletehttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id

Caminho Parâmetros

engagement_id
string
Obrigatório
exemploC1DEB879

ID associated with a specific engagement

Respostas

No content

Numbers

APIs relating to working with Numbers in Engagements

Operações disponíveis

Retrieve Numbers associated with an engagement

Get numbers in engagement

gethttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id/numbers

Caminho Parâmetros

engagement_id
string
Obrigatório
exemploC1DEB879

ID associated with a specific engagement

Respostas
Tipo de conteúdo
application/json

List of numbers that are associated with an engagement

page_size
integer
exemplo10

Items per page

page
integer
Mín.1
exemplo2

Page Offset

total_pages
integer
Mín.1
exemplo100

Number of pages in the entire result set

total_items
integer
exemplo100

Number of items in the entire result set

_embedded
object
numbers
array
_links
object
engagement
object
href
string
exemplo{ "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/" }

Exemplo Resposta

{
   "page_size": 10,
   "page": 2,
   "total_pages": 100,
   "total_items": 100,
   "_embedded": {
      "numbers": [
         "15556660001",
         "15556660002"
      ],
      "_links": {
         "engagement": {
            "href": {
               "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/"
            }
         }
      }
   }
}

Add numbers to an engagement

Adds a series of numbers from an engagement. This endpoint supports partial successes. If a request is partially successful, the response code will be 207 and details can be found in the response body.

If all items succeed, you will receive a 200. If all items fail, you will receive a 400.

posthttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id/numbers

Caminho Parâmetros

engagement_id
string
Obrigatório
exemploC1DEB879

ID associated with a specific engagement

Corpo da solicitação
Tipo de conteúdo
application/json

numbers
array
Obrigatório

Exemplo Solicitação

{
   "numbers": [
      "15556660001",
      "15556660002"
   ]
}
{
   "numbers": [
      "15556660001",
      "15556660002"
   ]
}

Respostas
Tipo de conteúdo
application/json

Successful bulk operation

numbers
array
_links
object
engagement
object
href
string
exemplo{ "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/" }

Exemplo Resposta

{
   "numbers": [
      "15556660001",
      "15556660002"
   ],
   "_links": {
      "engagement": {
         "href": {
            "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/"
         }
      }
   }
}

Remove a series of number from an engagement

Remove a series of numbers from an engagement. This endpoint supports partial successes. If a request is partially successful, the response code will be 207 and details can be found in the response body.

If all items succeed, you will receive a 200. If all items fail, you will receive a 400.

posthttps://api.nexmo.com/v1/messaging-engagement/engagements/:engagement_id/numbers/delete

Caminho Parâmetros

engagement_id
string
Obrigatório
exemploC1DEB879

ID associated with a specific engagement

Corpo da solicitação
Tipo de conteúdo
application/json

numbers
array
Obrigatório

Exemplo Solicitação

{
   "numbers": [
      "15556660001",
      "15556660002"
   ]
}
{
   "numbers": [
      "15556660001",
      "15556660002"
   ]
}

Respostas
Tipo de conteúdo
application/json

Successful bulk operation

numbers
array
_links
object
engagement
object
href
string
exemplo{ "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/" }

Exemplo Resposta

{
   "numbers": [
      "15556660001",
      "15556660002"
   ],
   "_links": {
      "engagement": {
         "href": {
            "value": "https://api.nexmo.com/v1/messaging-engagement/engagements/C1DEB879/"
         }
      }
   }
}