CLI UtilitiesDocumentedScanned
dsiprouter-skill
Call the dSIPRouter REST API using the Postman collection (curl +.
Share:
Installation
npx clawhub@latest install dsiprouter-skillView the full skill documentation and source below.
Documentation
dSIPRouter API skill
This skill is generated from the Postman collection and provides:
- a safe
curlcalling convention - a
bin/dsiprouter.shhelper CLI with subcommands for the collection’s requests - example payloads (where present in Postman)
Required environment
DSIP_ADDR— hostname/IP of your dSIPRouter node (no scheme)DSIP_TOKEN— API bearer token- Optional:
DSIP_INSECURE=1to allow self-signed TLS (adds-k)
Auth header: -Authorization: Bearer $DSIP_TOKEN## Safe calling convention __CODE_BLOCK_0__ ## Preferred usage: the bundled helper CLI __CODE_BLOCK_1__ ## Kamailio __CODE_BLOCK_2__ ## Endpoint catalog (from Postman) ### endpointgroups -endpointgroups:list→ **GET**/api/v1/endpointgroups-endpointgroups:get→ **GET**/api/v1/endpointgroups/9— Get a single endpointgroup -endpointgroups:create→ **POST**/api/v1/endpointgroups— Create an endpointgroup -endpointgroups:create_1→ **POST**/api/v1/endpointgroups— Create an endpointgroup -endpointgroups:create_2→ **POST**/api/v1/endpointgroups— Create an endpointgroup -endpointgroups:create_3→ **POST**/api/v1/endpointgroups— Create an endpointgroup -endpointgroups:delete→ **DELETE**/api/v1/endpointgroups/53— Delete endpointgroup -endpointgroups:update→ **PUT**/api/v1/endpointgroups/34— Update an endpointgroup ### kamailio -kamailio:reload→ **POST**/api/v1/reload/kamailio— Trigger a reload of Kamailio. This is needed after changes are made -kamailio:list→ **GET**/api/v1/kamailio/stats— Obtain call statistics ### inboundmapping -inboundmapping:list→ **GET**/api/v1/inboundmapping— Get a list of inboundmappings -inboundmapping:create→ **POST**/api/v1/inboundmapping— Create new inboundmapping -inboundmapping:update→ **PUT**/api/v1/inboundmapping?did=13132222223— Create new inboundmapping -inboundmapping:delete→ **DELETE**/api/v1/inboundmapping?did=13132222223— Create new inboundmapping ### leases -leases:list→ **GET**/api/v1/lease/endpoint?email=mack@goflyball.com&ttl=5m— Get a single endpointgroup -leases:list_1→ **GET**/api/v1/lease/endpoint?email=mack@goflyball.com&ttl=1m&type=ip&auth_ip=172.145.24.2— Get a single endpointgroup -leases:revoke→ **DELETE**/api/v1/lease/endpoint/34/revoke— Get a single endpointgroup ### carriergroups -carriergroups:list→ **GET**/api/v1/carriergroups-carriergroups:create→ **POST**/api/v1/carriergroups### auth -auth:create→ **POST**/api/v1/auth/user-auth:update→ **PUT**/api/v1/auth/user/2-auth:delete→ **DELETE**/api/v1/auth/user/2-auth:list→ **GET**/api/v1/auth/user-auth:login→ **POST**/api/v1/auth/login### cdr -cdr:get→ **GET**/api/v1/cdrs/endpointgroups/17?type=csv&dtfilter=2022-09-14&email=True-cdr:get_1→ **GET**/api/v1/cdrs/endpoint/54## Included files -bin/dsiprouter.sh`