Identity Verification and Message Engagement Registration

Wrapper for various Identity Verification services and Message Engagement Platforms

Descargar la especificación OpenAPI

Identities

APIs relating to working with Identities

Operaciones disponibles

Retrieve all of the identities associated with your account.

List identities

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

Respuestas
Tipo de contenido
application/json

List of brands that are associated with an account

page_size
integer
ejemplo10

Items per page

page
integer
Min1
ejemplo2

Page Offset

total_pages
integer
Min1
ejemplo100

Number of pages in the entire result set

total_items
integer
ejemplo100

Number of items in the entire result set

_embedded
object
brands
array
entity_type
string
ejemploPUBLIC_PROFIT
Debe ser uno de:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
ejemploVonage
company_name
string
ejemploVonage
ein
string
ejemplo20-1111111
alt_business_id_type
string
ejemploDUNS
alt_business_id
string
ejemplo150483782
phone
string
ejemplo+15556660001
street
string
ejemplo23 Main Street
city
string
ejemploHolmdel
state
string
ejemploNJ
postal_code
string
ejemplo07733
country
string
ejemploUS
email
string
ejemplodevrel@vonage.com
stock_symbol
string
ejemploVG
stock_exchange
string
ejemploNASDAQ
website
string
ejemplohttps://vonage.com
brand_relationship
string
ejemploKEY_ACCOUNT
Debe ser uno de:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
ejemploTECHNOLOGY
identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

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

Ejemplo Respuesta

{
   "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

Cuerpo de la solicitud
Tipo de contenido
application/json

Uno de
entity_type
string
Requerido
ejemploPUBLIC_PROFIT
Debe ser uno de:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
Requerido
ejemploVonage
company_name
string
ejemploVonage
ein
string
ejemplo20-1111111
alt_business_id_type
string
ejemploDUNS
alt_business_id
string
ejemplo150483782
phone
string
Requerido
ejemplo+15556660001
street
string
ejemplo23 Main Street
city
string
ejemploHolmdel
state
string
ejemploNJ
postal_code
string
ejemplo07733
country
string
Requerido
ejemploUS
email
string
Requerido
ejemplodevrel@vonage.com
stock_symbol
string
ejemploVG
stock_exchange
string
ejemploNASDAQ
website
string
ejemplohttps://vonage.com
brand_relationship
string
Requerido
ejemploKEY_ACCOUNT
Debe ser uno de:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
ejemploTECHNOLOGY

Ejemplo Solicitar

{
   "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"
}

Respuestas
Tipo de contenido
application/json

Return a single identity

entity_type
string
ejemploPUBLIC_PROFIT
Debe ser uno de:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
ejemploVonage
company_name
string
ejemploVonage
ein
string
ejemplo20-1111111
alt_business_id_type
string
ejemploDUNS
alt_business_id
string
ejemplo150483782
phone
string
ejemplo+15556660001
street
string
ejemplo23 Main Street
city
string
ejemploHolmdel
state
string
ejemploNJ
postal_code
string
ejemplo07733
country
string
ejemploUS
email
string
ejemplodevrel@vonage.com
stock_symbol
string
ejemploVG
stock_exchange
string
ejemploNASDAQ
website
string
ejemplohttps://vonage.com
brand_relationship
string
ejemploKEY_ACCOUNT
Debe ser uno de:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
ejemploTECHNOLOGY
identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

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

Ejemplo Respuesta

{
   "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

Ruta Parámetros

identity_id
string
Requerido
ejemploBLQKOPK

Identity ID associated with a number

Respuestas
Tipo de contenido
application/json

Return a single identity

entity_type
string
ejemploPUBLIC_PROFIT
Debe ser uno de:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
ejemploVonage
company_name
string
ejemploVonage
ein
string
ejemplo20-1111111
alt_business_id_type
string
ejemploDUNS
alt_business_id
string
ejemplo150483782
phone
string
ejemplo+15556660001
street
string
ejemplo23 Main Street
city
string
ejemploHolmdel
state
string
ejemploNJ
postal_code
string
ejemplo07733
country
string
ejemploUS
email
string
ejemplodevrel@vonage.com
stock_symbol
string
ejemploVG
stock_exchange
string
ejemploNASDAQ
website
string
ejemplohttps://vonage.com
brand_relationship
string
ejemploKEY_ACCOUNT
Debe ser uno de:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
ejemploTECHNOLOGY
identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

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

Ejemplo Respuesta

{
   "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

Ruta Parámetros

identity_id
string
Requerido
ejemploBLQKOPK

Identity ID associated with a number

Cuerpo de la solicitud
Tipo de contenido
application/json

entity_type
string
ejemploPUBLIC_PROFIT
Debe ser uno de:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
ejemploVonage
website
string
ejemplohttps://vonage.com
phone
string
ejemplo+15556660001
street
string
ejemplo23 Main Street
city
string
ejemploHolmdel
state
string
ejemploNJ
postal_code
string
ejemplo07733
country
string
ejemploUS
email
string
ejemplodevrel@vonage.com
stock_symbol
string
ejemploVG
stock_exchange
string
ejemploNASDAQ
brand_relationship
string
ejemploKEY_ACCOUNT
vertical
string
ejemploTECHNOLOGY

Ejemplo Solicitar

{
   "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"
}

Respuestas
Tipo de contenido
application/json

Return a single identity

entity_type
string
ejemploPUBLIC_PROFIT
Debe ser uno de:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
ejemploVonage
company_name
string
ejemploVonage
ein
string
ejemplo20-1111111
alt_business_id_type
string
ejemploDUNS
alt_business_id
string
ejemplo150483782
phone
string
ejemplo+15556660001
street
string
ejemplo23 Main Street
city
string
ejemploHolmdel
state
string
ejemploNJ
postal_code
string
ejemplo07733
country
string
ejemploUS
email
string
ejemplodevrel@vonage.com
stock_symbol
string
ejemploVG
stock_exchange
string
ejemploNASDAQ
website
string
ejemplohttps://vonage.com
brand_relationship
string
ejemploKEY_ACCOUNT
Debe ser uno de:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
ejemploTECHNOLOGY
identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

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

Ejemplo Respuesta

{
   "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

Ruta Parámetros

identity_id
string
Requerido
ejemploBLQKOPK

Identity ID associated with a number

Cuerpo de la solicitud
Tipo de contenido
application/json

entity_type
string
ejemploPUBLIC_PROFIT
Debe ser uno de:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
ejemploVonage
website
string
ejemplohttps://vonage.com
phone
string
ejemplo+15556660001
street
string
ejemplo23 Main Street
city
string
ejemploHolmdel
state
string
ejemploNJ
postal_code
string
ejemplo07733
country
string
ejemploUS
email
string
ejemplodevrel@vonage.com
stock_symbol
string
ejemploVG
stock_exchange
string
ejemploNASDAQ
brand_relationship
string
ejemploKEY_ACCOUNT
vertical
string
ejemploTECHNOLOGY

Ejemplo Solicitar

{
   "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"
}

Respuestas
Tipo de contenido
application/json

Return a single identity

entity_type
string
ejemploPUBLIC_PROFIT
Debe ser uno de:INDIVIDUALPRIVATE_PROFITPUBLIC_PROFICNON_PROFIT
display_name
string
ejemploVonage
company_name
string
ejemploVonage
ein
string
ejemplo20-1111111
alt_business_id_type
string
ejemploDUNS
alt_business_id
string
ejemplo150483782
phone
string
ejemplo+15556660001
street
string
ejemplo23 Main Street
city
string
ejemploHolmdel
state
string
ejemploNJ
postal_code
string
ejemplo07733
country
string
ejemploUS
email
string
ejemplodevrel@vonage.com
stock_symbol
string
ejemploVG
stock_exchange
string
ejemploNASDAQ
website
string
ejemplohttps://vonage.com
brand_relationship
string
ejemploKEY_ACCOUNT
Debe ser uno de:BASIC_ACCOUNTSMALL_ACCOUNTMEDIUM_ACCOUNTLARGE_ACCOUNTKEY_ACCOUNT
vertical
string
ejemploTECHNOLOGY
identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

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

Ejemplo Respuesta

{
   "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

Ruta Parámetros

identity_id
string
Requerido
ejemploBLQKOPK

Identity ID associated with a number

Respuestas

No content

Engagements

APIs relating to working with Engagements

Operaciones disponibles

Retrieve all of the engagements

List engagements

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

Respuestas
Tipo de contenido
application/json

List of engagements that are associated with an identity

page_size
integer
ejemplo10

Items per page

page
integer
Min1
ejemplo2

Page Offset

total_pages
integer
Min1
ejemplo100

Number of pages in the entire result set

total_items
integer
ejemplo100

Number of items in the entire result set

_embedded
object
brands
array
identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

vertical
string
ejemploTECHNOLOGY
use_case
string
ejemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
ejemplostring
description
string
ejemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
ejemplotrue
direct_lending
boolean
ejemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
ejemploSample Message
sample_two
string
ejemploAdditional Sample Message
sample_three
string
ejemploAdditional Sample Message
sample_four
string
ejemploAdditional Sample Message
message_flow
string
ejemplostring
help_message
string
ejemplostring
affiliate_marketing
boolean
ejemplotrue
engagement_id
string
ejemploC1DEB879

ID associated with a specific engagement

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

Ejemplo Respuesta

{
   "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

Cuerpo de la solicitud
Tipo de contenido
application/json

identity_id
string
Requerido
ejemploBLQKOPK

Identity ID associated with a number

vertical
string
Requerido
ejemploTECHNOLOGY
use_case
string
Requerido
ejemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
ejemplostring
description
string
Requerido
ejemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
ejemplotrue
direct_lending
boolean
ejemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
ejemploSample Message
sample_two
string
ejemploAdditional Sample Message
sample_three
string
ejemploAdditional Sample Message
sample_four
string
ejemploAdditional Sample Message
message_flow
string
ejemplostring
help_message
string
ejemplostring
affiliate_marketing
boolean
ejemplotrue

Ejemplo Solicitar

{
   "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
}

Respuestas
Tipo de contenido
application/json

Return a single engagement

identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

vertical
string
ejemploTECHNOLOGY
use_case
string
ejemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
ejemplostring
description
string
ejemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
ejemplotrue
direct_lending
boolean
ejemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
ejemploSample Message
sample_two
string
ejemploAdditional Sample Message
sample_three
string
ejemploAdditional Sample Message
sample_four
string
ejemploAdditional Sample Message
message_flow
string
ejemplostring
help_message
string
ejemplostring
affiliate_marketing
boolean
ejemplotrue
engagement_id
string
ejemploC1DEB879

ID associated with a specific engagement

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

Ejemplo Respuesta

{
   "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

Ruta Parámetros

engagement_id
string
Requerido
ejemploC1DEB879

ID associated with a specific engagement

Respuestas
Tipo de contenido
application/json

Return a single engagement

identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

vertical
string
ejemploTECHNOLOGY
use_case
string
ejemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
ejemplostring
description
string
ejemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
ejemplotrue
direct_lending
boolean
ejemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
ejemploSample Message
sample_two
string
ejemploAdditional Sample Message
sample_three
string
ejemploAdditional Sample Message
sample_four
string
ejemploAdditional Sample Message
message_flow
string
ejemplostring
help_message
string
ejemplostring
affiliate_marketing
boolean
ejemplotrue
engagement_id
string
ejemploC1DEB879

ID associated with a specific engagement

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

Ejemplo Respuesta

{
   "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

Ruta Parámetros

engagement_id
string
Requerido
ejemploC1DEB879

ID associated with a specific engagement

Cuerpo de la solicitud
Tipo de contenido
application/json

identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

vertical
string
ejemploTECHNOLOGY
use_case
string
ejemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
ejemplostring
description
string
ejemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
ejemplotrue
direct_lending
boolean
ejemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
ejemploSample Message
sample_two
string
ejemploAdditional Sample Message
sample_three
string
ejemploAdditional Sample Message
sample_four
string
ejemploAdditional Sample Message
message_flow
string
ejemplostring
help_message
string
ejemplostring
affiliate_marketing
boolean
ejemplotrue

Ejemplo Solicitar

{
   "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
}

Respuestas
Tipo de contenido
application/json

Return a single engagement

identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

vertical
string
ejemploTECHNOLOGY
use_case
string
ejemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
ejemplostring
description
string
ejemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
ejemplotrue
direct_lending
boolean
ejemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
ejemploSample Message
sample_two
string
ejemploAdditional Sample Message
sample_three
string
ejemploAdditional Sample Message
sample_four
string
ejemploAdditional Sample Message
message_flow
string
ejemplostring
help_message
string
ejemplostring
affiliate_marketing
boolean
ejemplotrue
engagement_id
string
ejemploC1DEB879

ID associated with a specific engagement

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

Ejemplo Respuesta

{
   "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

Ruta Parámetros

engagement_id
string
Requerido
ejemploC1DEB879

ID associated with a specific engagement

Cuerpo de la solicitud
Tipo de contenido
application/json

identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

vertical
string
ejemploTECHNOLOGY
use_case
string
ejemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
ejemplostring
description
string
ejemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
ejemplotrue
direct_lending
boolean
ejemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
ejemploSample Message
sample_two
string
ejemploAdditional Sample Message
sample_three
string
ejemploAdditional Sample Message
sample_four
string
ejemploAdditional Sample Message
message_flow
string
ejemplostring
help_message
string
ejemplostring
affiliate_marketing
boolean
ejemplotrue

Ejemplo Solicitar

{
   "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
}

Respuestas
Tipo de contenido
application/json

Return a single engagement

identity_id
string
ejemploBLQKOPK

Identity ID associated with a number

vertical
string
ejemploTECHNOLOGY
use_case
string
ejemploACCOUNT_NOTIFICATION
sub_use_cases
array
reseller_id
string
ejemplostring
description
string
ejemploUser notifications
embedded_link
boolean
embedded_phone
boolean
number_pool
boolean
age_gated
boolean
ejemplotrue
direct_lending
boolean
ejemplotrue
subscriber_optin
boolean
subscriber_optout
boolean
subscriber_help
boolean
sample_one
string
ejemploSample Message
sample_two
string
ejemploAdditional Sample Message
sample_three
string
ejemploAdditional Sample Message
sample_four
string
ejemploAdditional Sample Message
message_flow
string
ejemplostring
help_message
string
ejemplostring
affiliate_marketing
boolean
ejemplotrue
engagement_id
string
ejemploC1DEB879

ID associated with a specific engagement

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

Ejemplo Respuesta

{
   "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

Ruta Parámetros

engagement_id
string
Requerido
ejemploC1DEB879

ID associated with a specific engagement

Respuestas

No content

Numbers

APIs relating to working with Numbers in Engagements

Operaciones disponibles

Retrieve Numbers associated with an engagement

Get numbers in engagement

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

Ruta Parámetros

engagement_id
string
Requerido
ejemploC1DEB879

ID associated with a specific engagement

Respuestas
Tipo de contenido
application/json

List of numbers that are associated with an engagement

page_size
integer
ejemplo10

Items per page

page
integer
Min1
ejemplo2

Page Offset

total_pages
integer
Min1
ejemplo100

Number of pages in the entire result set

total_items
integer
ejemplo100

Number of items in the entire result set

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

Ejemplo Respuesta

{
   "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

Ruta Parámetros

engagement_id
string
Requerido
ejemploC1DEB879

ID associated with a specific engagement

Cuerpo de la solicitud
Tipo de contenido
application/json

numbers
array
Requerido

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

Successful bulk operation

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

Ejemplo Respuesta

{
   "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

Ruta Parámetros

engagement_id
string
Requerido
ejemploC1DEB879

ID associated with a specific engagement

Cuerpo de la solicitud
Tipo de contenido
application/json

numbers
array
Requerido

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

Successful bulk operation

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

Ejemplo Respuesta

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