Skip to content

Commit 9eda9a2

Browse files
author
Faxbot Agent
committed
docs(plugins): list available example manifests (faxplus, ringcentral, interfax, sfax, pamfax, dropbox_fax) + tabs with RingCentral/InterFAX examples
1 parent bf19745 commit 9eda9a2

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

docs/plugins/index.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,68 @@ Admin Console integration
4747
Learn more
4848
- [Curated Registry](registry.md)
4949
- [HTTP Manifest Providers](manifest-http.md)
50+
51+
---
52+
53+
## Manifests available (examples)
54+
55+
These example manifests live in the repo and can be used as starting points.
56+
57+
- id `faxplus` — Fax.Plus
58+
- id `ringcentral` — RingCentral
59+
- id `interfax` — InterFAX
60+
- id `sfax` — Sfax (Consensus)
61+
- id `pamfax` — PamFax
62+
- id `dropbox_fax` — Dropbox Fax
63+
64+
=== "RingCentral example"
65+
66+
```json
67+
{
68+
"id": "ringcentral",
69+
"name": "RingCentral Fax API",
70+
"auth": { "scheme": "bearer" },
71+
"actions": {
72+
"send_fax": {
73+
"method": "POST",
74+
"url": "https://platform.ringcentral.com/restapi/v1.0/account/~/extension/~/fax",
75+
"body": { "kind": "multipart", "template": "request={\\"to\\":[{\\"phoneNumber\\":\\"{{to}}\\"}]}&attachment={{file}}" },
76+
"response": { "faxId": "id" }
77+
},
78+
"get_status": {
79+
"method": "GET",
80+
"url": "https://platform.ringcentral.com/restapi/v1.0/account/~/message-store/{{fax_id}}",
81+
"body": { "kind": "none", "template": "" },
82+
"response": { "status": "messageStatus", "sentPages": "faxPageCount" }
83+
}
84+
},
85+
"allowed_domains": ["platform.ringcentral.com"],
86+
"timeout_ms": 15000
87+
}
88+
```
89+
90+
=== "InterFAX example"
91+
92+
```json
93+
{
94+
"id": "interfax",
95+
"name": "InterFAX API",
96+
"auth": { "scheme": "basic" },
97+
"actions": {
98+
"send_fax": {
99+
"method": "POST",
100+
"url": "https://rest.interfax.net/outbound/faxes?faxNumber={{to}}",
101+
"headers": { "Content-Location": "{{file_url}}", "Content-Type": "application/pdf" },
102+
"body": { "kind": "none", "template": "" },
103+
"response": { "faxId": "id" }
104+
},
105+
"get_status": {
106+
"method": "GET",
107+
"url": "https://rest.interfax.net/outbound/faxes/{{fax_id}}",
108+
"body": { "kind": "none", "template": "" },
109+
"response": { "status": "status" }
110+
}
111+
},
112+
"allowed_domains": ["rest.interfax.net"]
113+
}
114+
```

0 commit comments

Comments
 (0)