...
Botdoc P2 Container is a session with multiple secure Features inside of it, with P2 you can make a Flow automation or just a simple file "push", "pull", “DocuSign” or “DocuSign”“External URL”.
Endpoint: https://api.botdoc.io/v1/module_container/container/
Method: POST.
Example of the body in JSON format:
| Code Block |
|---|
|
{
"page_type": "p2",
"callback_url": "https://link.to.your.callback.url",
"display_chat": true
} |
Example how to create a Container by cURL:
| Code Block |
|---|
|
curl -i --request POST "https://api.botdoc.io/v1/module_container/container/" \
--header "Authorization: JWT <Authorization Token>" \
--header "Content-Type: application/json" \
--data-raw "{
"page_type": "p2",
"callback_url": "https://link.to.your.callback.url",
"display_chat": true
}" |
1.2 - Create a Container with a Requester:
...
| Code Block |
|---|
|
{
"first_name": "John",
"last_name": "Smith"
} |
Example how to create a Container Recipient by cURL:
| Code Block |
|---|
|
curl -i --request POST "https://api.botdoc.io/v1/module_container/container/{container_id}/recipient/" \
--header "Authorization: JWT <Authorization Token>" \
--header "Content-Type: application/json" \
--data-raw "{
"first_name": "John",
"last_name": "Smith"
}
" |
...
| Code Block |
|---|
|
{
"interface_class": "email", //can be "email" or "sms"
"value": "myemail@botdoc.io"
} |
Example how to create a Container Recipient Item by cURL:
| Code Block |
|---|
|
curl -i --request POST "https://api.botdoc.io/v1/module_container/recipient/{recipient_id}/recipient_item/" \
--header "Authorization: JWT <Authorization Token>" \
--header "Content-Type: application/json" \
--data-raw "{
"interface_class": "email",
"value": "myemail@botdoc.io"
}
" |
...
| Code Block |
|---|
|
curl -i --request POST "https://api.botdoc.io/v1/module_container_pull/pull/" \
--header "Authorization: JWT <Authorization Token>" \
--header "Content-Type: application/json" \
--data-raw "{
"container": {container_id},
"title": "Nice Pull Title",
"description": "Nice Pull Desc."
}" |
7.2 - Push Feature
If you want to SEND file(s) to your Receiver, you must send a Push Feature:
Endpoint: https://api.botdoc.io/v1/module_container_push/push/
Method: POST.
...
| Code Block |
|---|
|
curl -i --request POST "https://api.botdoc.io/v1/module_container_push/push/" \
--header "Authorization: JWT <Authorization Token>" \
--header "Content-Type: application/json" \
--data-raw "{
"container": {container_id},
"title": "Nice Push Title",
"description": "Nice Push Desc.",
"max_file_downloads": 4
}" |
7.2.1 - Push File Feature
If you want to SEND file(s) to your Receiver, you must send a Push Feature and a Push File (required):
Endpoint: https://api.botdoc.io/v1/module_container_push/pushfile/
Method: POST.
...
| Code Block |
|---|
|
curl -i --request POST "https://api.botdoc.io/v1/module_container_push/pushfile/" \
--header "Authorization: JWT <Authorization Token>" \
--header "Content-Type: multipart/form-data" \
--form "file=@C:\invoices\invoice_2020.pdf" \
--form "name=invoice_2020.pdf" \
--form "push={push_id}" \
--form "total_chunks=1" |
7.3 - DocuSign Feature
If you want the Receiver to Sign something, you must send a DocuSign Feature:
Endpoint: https://api.botdoc.io/v1/module_container_docusign/docusign/
Method: POST.
...
| Code Block |
|---|
|
curl -i --request POST "https://api.botdoc.io/v1/module_container_docusign/docusign/" \
--header "Authorization: JWT <Authorization Token>" \
--header "Content-Type: application/json" \
--data-raw "{
"title": "Sign this doc. pls",
"description": "this document allows you to get an bank loan",
"envelope": {
"template_id": "f53858a0-4810-492a-aba7-8dda6eb83ffc",
"recipients": {
"signers": [
{
"name": "John Smith",
"email": "myemail@botdoc.io",
"client_user_id": "{recipient_id}",
"role_name": "Signer"
}
]
}
},
"container": {container_id}
}" |
...
7.4 - External URL Feature
If you want to send some link(s)
...
Now, just send to your receiver, you must send a External URL, the URL in the body must have a https:// prefix.
Endpoint: https://api.botdoc.io/v1/module_container_iframe/iframe/
Method: POST.
Example of the body in JSON format:
| Code Block |
|---|
|
{
"container": {container_id},
"title": "Nice External URL Title",
"description": "Nice External URL Description",
"url": "https://botdoc.io/"
} |
Example how to create a External URL Feature by cURL:
| Code Block |
|---|
|
curl -i --request POST "https://api.botdoc.io/v1/module_container_iframe/iframe/" \
--header "Authorization: JWT <Authorization Token>" \
--header "Content-Type: application/json" \
--data-raw "{
"container": {container_id},
"title": "Nice External URL Title",
"description": "Nice External URL Description",
"url": "https://botdoc.io/"
}" |
8 - Send the Notification to the Receiver(s)
Now, just send the Notification to the Receiver(s).
Endpoint: https://api.botdoc.io/v1/module_container/container/{container_id}/send_notification/
Method: POST.
...
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 5 |
|---|
| spaces | com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@75205211 | showSpace | false |
|---|
| sort | modified |
|---|
| typeshowSpace | pagefalse |
|---|
| reverse | true | labels |
|---|
kb-how-to-article| type | page | | cql | label = "kb-how-to-article" and type = "page" and space = "BOTDOC" |
|---|
| labels | kb-how-to-article |
|---|
|
...