Skip to main content

Vonage Account API package

Project description

Vonage Account Package

This package contains the code to use Vonage's Account API in Python.

It includes methods for managing Vonage accounts.

Usage

It is recommended to use this as part of the main vonage package. The examples below assume you've created an instance of the vonage.Vonage class called vonage_client.

Get Account Balance

balance = vonage_client.account.get_balance()
print(balance)

Top-Up Account

response = vonage_client.account.top_up(trx='1234567890')
print(response)

Update the Default SMS Webhook

This will return a Pydantic object (SettingsResponse) containing multiple settings for your account.

settings: SettingsResponse = vonage_client.account.update_default_sms_webhook(
    mo_callback_url='https://example.com/inbound_sms_webhook',
    dr_callback_url='https://example.com/delivery_receipt_webhook',
)

print(settings)

List Secrets Associated with the Account

response = vonage_client.account.list_secrets()
print(response)

Create a New Account Secret

secret = vonage_client.account.create_secret('Mytestsecret12345')
print(secret)

Get Information About One Secret

secret = vonage_client.account.get_secret(MY_SECRET_ID)
print(secret)

Revoke a Secret

Note: it isn't possible to revoke all account secrets, there must always be one valid secret. Attempting to do so will give a 403 error.

client.account.revoke_secret(MY_SECRET_ID)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vonage_account-1.0.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

vonage_account-1.0.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file vonage_account-1.0.1.tar.gz.

File metadata

  • Download URL: vonage_account-1.0.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.4

File hashes

Hashes for vonage_account-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6f392e2bb6121fc2d329b6fc3732a457a56567dff69e5a4b4d09bcf56c846045
MD5 8d1495f4b71dcdff5d601c1e4fe02ce7
BLAKE2b-256 358d270beff48b65bf99d509b7b7e4c3822fe1e84d22ed00257e20b351b74f7d

See more details on using hashes here.

File details

Details for the file vonage_account-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for vonage_account-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 340fe9f1175e6b98885f535fbb05396c8308514b2def939d2b671f8017be36ab
MD5 adc764c436602d1e32131b76cdcf9805
BLAKE2b-256 f65d89f6555fffea63110de921fc6da45a3f55853286d90ebef09acdac728788

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page