phone.setCallRating

Rate a call

Example

Javascript

const {Api, TelegramClient} = require('telegram');
const {StringSession} = require('telegram/sessions');

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result = await client.invoke(new Api.phone.setCallRating({
        userInitiative: true,
        peer: new Api.InputPhoneCall({...}),
        rating: 4475374,
        comment: 'random string here',
        }));
    console.log(result); // prints the result
})();

TypeScript

import {Api, TelegramClient} from 'telegram';
import {StringSession} from 'telegram/sessions';

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result: Api.Updates with info about the rating message sent to the official VoIP bot = await client.invoke(new Api.phone.setCallRating({
        userInitiative: true,
        peer: new Api.InputPhoneCall({...}),
        rating: 4475374,
        comment: 'random string here',
        }));
    console.log(result); // prints the result
})();

TL schema

updatesTooLong#e317af7e = Updates;
updateShortMessage#2296d2c8 flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true id:int user_id:int message:string pts:int pts_count:int date:int fwd_from:flags.2?MessageFwdHeader via_bot_id:flags.11?int reply_to:flags.3?MessageReplyHeader entities:flags.7?Vector<MessageEntity> = Updates;
updateShortChatMessage#402d5dbb flags:# out:flags.1?true mentioned:flags.4?true media_unread:flags.5?true silent:flags.13?true id:int from_id:int chat_id:int message:string pts:int pts_count:int date:int fwd_from:flags.2?MessageFwdHeader via_bot_id:flags.11?int reply_to:flags.3?MessageReplyHeader entities:flags.7?Vector<MessageEntity> = Updates;
updateShort#78d4dec1 update:Update date:int = Updates;
updatesCombined#725b04c3 updates:Vector<Update> users:Vector<User> chats:Vector<Chat> date:int seq_start:int seq:int = Updates;
updates#74ae4240 updates:Vector<Update> users:Vector<User> chats:Vector<Chat> date:int seq:int = Updates;
updateShortSentMessage#11f1331c flags:# out:flags.1?true id:int pts:int pts_count:int date:int media:flags.9?MessageMedia entities:flags.7?Vector<MessageEntity> = Updates;
---functions---
phone.setCallRating#59ead627 flags:# user_initiative:flags.0?true peer:InputPhoneCall rating:int comment:string = Updates;

Parameters

Name	Type	Description
flags	#	Flags, see TL conditional fields
user_initiative	flags.0?true	Whether the user decided on their own initiative to rate the call
peer	InputPhoneCall	The call to rate
rating	int	Rating in 1-5 stars
comment	string	An additional comment

Result

Updates with info about the rating message sent to the official VoIP bot

Possible errors

Code	Type	Description
400	CALL_PEER_INVALID	The provided call peer object is invalid

Can bots use this methd ?

yes

Related pages