Doc Partner
SMS Partner
Doc Partner - EN
Doc Partner - EN
  • Welcome
  • API
    • SMS Partner
      • Credits
      • Send SMS
        • Single Send
        • Bulk Send
        • Send by Long Number
        • Survey Send
        • Cancel Scheduled SMS
        • Special Characters
      • Status & Statistics
        • Single Status
        • Bulk Status
        • Status by Message
        • Status by Tag
        • Sending Statistics
      • Contact Management
        • Add Group
        • Add Contact
        • Delete Group
        • Add Bulk Contacts
        • Edit Contact
        • Delete Contact
        • Get Group List
        • Get Contact List
        • Get Contact Details
      • Replies / Opt-outs Management
        • Stop List
        • Add Number to SMS Stop List
        • Remove Number from SMS Stop List
        • Replies Management
      • Sub-accounts
        • Activation
        • Create Sub-account
        • Delete Sub-account
        • Sub-account List
        • Manage Sub-account Credits
      • Manage Call Forwarding
      • Number Verification
        • Send a Verification
        • Format Verification
      • Contact Rental
        • Categories
        • Targeting & Calculation
        • Rental Status
        • Download File
      • RCS
    • Error Codes
Powered by GitBook

© 2025 NDA Media

On this page
  1. API
  2. SMS Partner

Manage Call Forwarding

This request is used to configure a call forwarding rule

URL

POST https://api.smspartner.fr/v1/vn/callforward

Required Parameters

Name
Value

apiKey

number

Virtual number

type

Forwarding type: 0 → Disabled 1 → Call forwarding 2 → Voicemail

param

If type = 0 → leave empty If type = 1 → enter forwarding number If type = 2 → enter the email to be notified

Request

curl --location 'https://api.smspartner.fr/v1/vn/callforward' \
--header 'Content-Type: application/json' \
--data '{
    "apiKey": "API_KEY",
    "number": "NUMBET",
    "type": 0, 
    "param": ""
}'

Response

{
    "success": true,
    "code": 2,
    "message": "Callforward disabled"
}

Errors

{
    "success": false,
    "code": 5,
    "message": "email is not valid"
}

Error Codes

Response Code
Message

10

API key is required

1

name is required

5

Virtual number is required

6

Type is required

7

Type is invalid

8

param is required

9

Email is invalid

12

Forwarding number is invalid

13

Virtual number does not exist

14

Call forwarding is not enabled

15

Number is deactivated

16

Call forwarding is already enabled

17

Voicemail is already enabled

18

Call forwarding is already disabled

PreviousManage Sub-account CreditsNextNumber Verification

Last updated 1 month ago

Your API key