Scope
account-wallets:read
Filter (Query Parameter)
Currently you can filter by the following attributes:
name - filter by wallet name. E.g. name eq 'product_usage'.
product_name - filter by product name. E.g. product_name eq 'SaaS Consumption-Licensing'.
Supported comparison operators:
contains - match if any value is within the list, i.e. evaluates to true if any value of the contains operand matches the value in the database. E.g. contains(product_name, 'standard').
eq - exact match, i.e. only evaluates to true if both operands have the same value. E.g. name eq 'saas_licenses'.
Supported logical operators:
and - AND logical operator. E.g. name eq 'saas_licenses' and product_name eq 'Talkdesk Fax'.
or - OR logical operator. E.g. name eq 'saas_licenses' or product_name eq 'Talkdesk Fax'.
not - NOT logical operator. E.g. not product_name eq 'product_usage'.
Supported precedence operators:
( and ) - parentheses precedence operator. You can force some expressions to be evaluated first than another by enclosing them into parentheses E.g. (name eq 'saas_licenses' and product_name eq 'Talkdesk Fax') or name eq 'guardian' is different than name eq 'saas_licenses' and (product_name eq 'Talkdesk Fax' or name eq 'guardian').
Values must have single quotes marks e.g.: name eq 'guardian'
Examples
-
filter=product_name eq 'Saas Licenses' and (name eq 'saas_licenses' and contains(product_name, 'digital') - Retrieve the wallets that have product_name 'Saas Licenses' and thatname is 'saas_licenses' or product_name contains the string 'digital' within.
-
`filter=name eq 'ai_premium_batch' or contains(product_name, 'realtime') - Retrieves the wallets that have name 'ai_premium_batch' or that product_name contains the string 'realtime' within.
Body Response - Schema
200 (account wallet list)
| Parameter | Type | Description | Required |
|---|---|---|---|
| total | integer | n/a | yes |
| count | integer | n/a | yes |
| page | integer | n/a | yes |
| per_page | integer | n/a | yes |
| _links | object | "_links" subdivides into: "self" (object), required, which subdivides into "href" (string), required. "first" (object), which subdivides into "href" (string), required. "prev" (object), which subdivides into "href" (string), required. "next" (object), which subdivides into "href" (string), required. "last" (object), which subdivides into "href" (string), required. | yes |
| _embedded | object | "_links" subdivides into: "wallets" (array[object] ), required, which subdivides into: 1 - "name" (string), required. Wallet name; >= 1 characters; <= 255 characters. 2 - "product_name" (string), required. Wallet's prodcut name; >= 1 characters; <= 255 characters. 3 - "balance" (number ), required. Wallet balance in credits. Credits represents x10000 the real currency value. 4 - "account_id" (string ), required. Talkdesk Account ID. 5 - "created_at" (string ), required. Wallet creation datetime. 6 - "updated_at" (string ), required. Wallet update datetime. 6 - "_links" (object), required. 7.1 - "self" (object), required. Link to the current Location of the resource. 7.1.1 - "href" (string), required. The hypertext reference describing this link. | yes |
400 (bad request), 401 (unauthorized), 403 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.