API by router
Worker bindings
GET
instance_id*Instance IdFormat
uuidcustomer_id*Customer IdFormat
uuidSuccessful Response
response?unknownapplication/jsoncurl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/worker-bindings?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
nullPOST
instance_id*Instance IdFormat
uuidapplication/json- body
channel_address*Channel AddressLength
1 <= length <= 255channel_type*Channel TypeOne of: ('whatsapp', 'sms', 'voice', 'telegram', 'email')
customer_id*Customer IdFormat
uuidperson_id*Person IdFormat
uuidSuccessful Response
response?unknownapplication/jsoncurl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/worker-bindings' \ -H 'Content-Type: application/json' \ -d '{ "channel_address": "string", "channel_type": "string", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550"}'Example Response
nullPOST
instance_id*Instance IdFormat
uuidbinding_id*Binding IdFormat
uuidapplication/json- body
new_address*New AddressLength
1 <= length <= 255Successful Response
response?unknownapplication/jsoncurl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/worker-bindings/497f6eca-6276-4993-bfeb-53cbbbba6f08/rebind' \ -H 'Content-Type: application/json' \ -d '{ "new_address": "string"}'Example Response
nullPOST
instance_id*Instance IdFormat
uuidbinding_id*Binding IdFormat
uuidSuccessful Response
response?unknownapplication/jsoncurl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/worker-bindings/497f6eca-6276-4993-bfeb-53cbbbba6f08/revoke'Example Response
nullGET
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidX-Api-Key?string|nullSuccessful Response
response?unknownapplication/jsoncurl -X GET 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/worker-bindings'Example Response
nullPOST
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidX-Api-Key?string|nullapplication/json- body
channel_address*Channel AddressLength
1 <= length <= 255channel_type*Channel TypeOne of: ('whatsapp', 'sms', 'voice', 'telegram', 'email')
customer_id*Customer IdFormat
uuidperson_id*Person IdFormat
uuidSuccessful Response
response?unknownapplication/jsoncurl -X POST 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/worker-bindings' \ -H 'Content-Type: application/json' \ -d '{ "channel_address": "string", "channel_type": "string", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550"}'Example Response
nullPOST
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidbinding_id*Binding IdFormat
uuidX-Api-Key?string|nullapplication/json- body
new_address*New AddressLength
1 <= length <= 255Successful Response
response?unknownapplication/jsoncurl -X POST 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/worker-bindings/497f6eca-6276-4993-bfeb-53cbbbba6f08/rebind' \ -H 'Content-Type: application/json' \ -d '{ "new_address": "string"}'Example Response
nullPOST
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidbinding_id*Binding IdFormat
uuidX-Api-Key?string|nullSuccessful Response
response?unknownapplication/jsoncurl -X POST 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/worker-bindings/497f6eca-6276-4993-bfeb-53cbbbba6f08/revoke'Example Response
null