BulkGate Helpdesk
  • Languages iconEnglish
    • Czech

›Address book

Blacklist

  • Black List download
  • Black List check
  • Addition to the Black List
  • Black List item removal

Address book

  • Get contact
  • Add contact
  • Edit contact
  • Import contacts
  • Remove contact
  • Opt-in consent

Price list

  • Get price list

Shortener

  • URL shortening
  • Changing URLs
  • Removing URLs

Opt-in consent

Parameter table common for all methods (show, add, remove)

https://portal.bulkgate.com/api/1.0/address-book/agreement/show
https://portal.bulkgate.com/api/1.0/address-book/agreement/add
https://portal.bulkgate.com/api/1.0/address-book/agreement/remove
PARAMETER NAMEVALUEMANDATORYDEFAULT VALUE
application_idApplication IDYes-
application_tokenApplication tokenYes-
phone_numberPhone number of the contactYes-

Show consent

API URL

URL used to send HTTP requests:

https://portal.bulkgate.com/api/1.0/address-book/agreement/show

Example of full request

POST /api/1.0/address-book/agreement/show HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

{
    "application_id": "####",
    "application_token": "#######################",
    "phone_number": "+420777777777",
}

Response to this command may be:

In case of success:

{
    "data": {
        "phone_number": "+420777777777",
        "agreement": "2023-03-30T13:29:15+02:00"
    }
}

In case of error:

{
    "type": "number_not_found",
    "code": 400,
    "error": "Number not found",
    "detail": null
}
{
    "type": "invalid_phone_mobile",
    "code": 400,
    "error": "Invalid phone mobile",
    "detail": null
}

Add consent

Note: If the phone number does not exist in the address book, it will be automatically added.

API URL

URL used to send HTTP requests:

https://portal.bulkgate.com/api/1.0/address-book/agreement/add

Example of full request

POST /api/1.0/address-book/agreement/add HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

{
    "application_id": "####",
    "application_token": "#######################",
    "phone_number": "+420777777777",
}

Response to this command may be:

In case of success:

{
    "data": {
        "phone_number": "+420777777777",
        "agreement": "2023-03-30T12:59:26+02:00"
    }
}

In case of error:

{
    "type": "invalid_phone_mobile",
    "code": 400,
    "error": "Invalid phone mobile",
    "detail": null
}

Remove consent

API URL

URL used to send HTTP requests:

https://portal.bulkgate.com/api/1.0/address-book/agreement/remove

Example of full request

POST /api/1.0/address-book/agreement/remove HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

{
    "application_id": "####",
    "application_token": "#######################",
    "phone_number": "+420777777777",
}

Response to this command may be:

In case of success:

{
    "data": {
        "phone_number": "+420777777777",
        "agreement": "null",
    }
}

In case of error:

{
    "type": "number_not_found",
    "code": 400,
    "error": "Number not found",
    "detail": null
}
{
    "type": "invalid_phone_mobile",
    "code": 400,
    "error": "Invalid phone mobile",
    "detail": null
}
← Remove contactGet price list →
  • Parameter table common for all methods (show, add, remove)
  • Show consent
    • API URL
    • Example of full request
    • Response to this command may be:
  • Add consent
    • API URL
    • Example of full request
    • Response to this command may be:
  • Remove consent
    • API URL
    • Example of full request
    • Response to this command may be:
SolutionsSMS GatewayViber for BusinessBroadcastBulk SMSSMS NotificationsTwo-way SMSMobile ConnectWeb Portal
Partners & DevelopersSMS APIIntegrationsAffiliate programWhite label
SourcesBlogYouTubeFacebookLinkedInTwitterGitHubPackagist
CompanyContactPrivacyTerms and Conditions
Price listsPrice list SMSPrice list ViberPrice list Mobile Connect
SMS GatewayTOPefekt s.r.o. © 2023