Microsoft BotFramework Driver doesn't put correct "From" field in outgoing message

[nadalizadeh]

• BotMan Version: not sure, 1.5 in composer.json ?
• PHP Version: 5.6
• Messaging Service(s): Telegram, Microsoft BotFramework
• Cache Driver: None

Description:

Observed:

• Framework receives message from BotFramework, calls the handle function and tries to reply, but the message on BotFramework doesn't get delivered.
• No error is thrown from the framework and I didn't have any way to know something is going wrong with the framework or not.

Debugged and found that:
Microsoft BotFramework is replying with the following message:

The bot referenced by the 'from' field is unrecognized

Log:

[2017/07/14 11:44:25] botman - matching drivers
[2017/07/14 11:44:25] botman - driver matched request Mpociot\BotMan\Drivers\BotFrameworkDriver
[2017/07/14 11:44:25] botman - start listen
[2017/07/14 11:44:25] botman - received hello
[2017/07/14 11:44:25] botman - POST to https://webchat.botframework.com//v3/conversations/xxxxxxxxxxxxxxxe860f1faf7a205e5a/activities 
--> with parameters --> {"type":"message","text":"Hello yourself.","from":{"id":"TexifyBot"}}
[2017/07/14 11:44:26] botman - response 
{
  "error": {
    "code": "MissingProperty",
    "message": "The bot referenced by the 'from' field is unrecognized"
  }
}
[2017/07/14 11:44:26] botman - finished

Related Issue:
microsoft/botframework-sdk#2450

Steps To Reproduce:

[nadalizadeh]

The issue could be fixed by changing the following code in BotFrameworkDriver.php:

        if (strstr($apiURL, 'webchat.botframework')) {
            $parameters['from'] = [
                'id' => $this->config->get('microsoft_bot_handle'),
            ];
        }

to this:

        if (strstr($apiURL, 'webchat.botframework')) {
            $parameters['from'] = [
                'id' => $payload['recipient']['id'],
            ];
        }

So that we reuse the received recipient id from BotFramework in response to it.

[nadalizadeh]

I should also note that current implementation of BotFramework doesn't support replying to other integrations on it such as Kik through BF.

It calls
https://kik.botframework.com/v3/conversations/..../activities
without from field and gets the following error from BotFramework
{"Error":{"Code":"MissingProperty","Message":"The 'from' field is required"}}

[mpociot]

Thank you for debugging this. Can you send me a pull request with your modifications? Ali N. <notifications@github.com> schrieb am Fr. 14. Juli 2017 um 11:34:

I should also note that current implementation of BotFramework doesn't support replying to other integrations on it such as Kik through BF. It calls https://kik.botframework.com/v3/conversations/..../activities without from field and gets the following error from BotFramework {"Error":{"Code":"MissingProperty","Message":"The 'from' field is required"}} — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#470 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAxHTEQ0ntAHNiUrC7Fbh_kzjbMTRP5Eks5sNzXHgaJpZM4OX6rZ> .

-- Marcel Pociot http://www.marcelpociot.com https://github.com/mpociot http://twitter.com/marcelpociot

[slakbal]

Any chance we can get this error somehow fixed. I'm also struggling with this on Microsoft Bot.
json "error": { "code": "MissingProperty", "message": "The bot referenced by the 'from' field is unrecognized" }

[nadalizadeh]

Thanks Marcel (@mpociot) for applying the patch,
I found that the patch fixed the driver for the "Web" integration
regarding other messenger integrations on Bot Framework such as Kik integration, the standard hasn't been implemented and responses still get errors from the Microsoft side.

We need to follow this standard:
https://docs.microsoft.com/en-us/bot-framework/rest-api/bot-framework-rest-connector-send-and-receive-messages

Hence change the code to the following please:

        // comment the if to allow all bot framework integrations
        // if (strstr($apiURL, 'webchat.botframework')) {
        	$parameters['from'] = $payload['recipient'];
		$parameters['recipient'] = $payload['from'];
		$parameters['conversation'] = $payload['conversation'];
        // }